Skip to main content
GET
/
v2
/
collections
/
{collectionId}
/
markets
Get markets
curl --request GET \
  --url https://rest.forestreet.com/v2/collections/{collectionId}/markets \
  --header 'x-api-key: <api-key>'
{
  "metadata": {
    "pagination": {
      "totalItems": 123,
      "totalPages": 123,
      "currentPage": 123,
      "pageSize": 123
    },
    "filters": {
      "isArchived": true
    },
    "sort": {
      "field": "id",
      "order": "asc"
    }
  },
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>",
      "headerImage": "<string>",
      "status": "<string>",
      "isEditable": true,
      "isArchived": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "companyCount": 123
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

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

Path Parameters

​
collectionId
integer
required

ID of the collection to which the markets belong.

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
​
sortBy
enum<string>
default:createdAt

Field to sort markets by. Default is createdAt.

Available options:
id,
name,
createdAt,
updatedAt,
status
​
sortOrder
enum<string>
default:desc

Order of sorting. Default is desc.

Available options:
asc,
desc
​
isArchived
boolean | null
default:false

Filter markets by archived status.

​
status
enum<string>

Filter markets by status.

Available options:
draft,
publishing,
published

Response

List markets in collection response

​
metadata
object
required
​
data
object[]
required