GET
/
v2
/
teams
/
{teamId}
/
collections
Get team collections
curl --request GET \
  --url https://rest.forestreet.com/v2/teams/{teamId}/collections \
  --header 'x-api-key: <api-key>'
{
  "metadata": {
    "pagination": {
      "totalItems": 123,
      "totalPages": 123,
      "currentPage": 123,
      "pageSize": 123
    }
  },
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>",
      "createdDate": "<string>",
      "isUserCreated": 123,
      "isDefault": 123,
      "isPrivate": 123
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Pass a static API key for every request, provided by your customer support.

Path Parameters

​
teamId
integer
required

ID of the team whose collections are being retrieved.

Required range: x > 0

Query Parameters

​
page
integer
default:1

Page number to retrieve, starting from 1.

Required range: x > 0
​
pageSize
integer
default:50

Number of markets per page.

Required range: 0 < x <= 100

Response

Get team collections response

The response is of type object.