List Collection

get

https://sandbox.api.yellowcard.io/business/collections

Get a list of collection requests

Query Params

endDate

string

a date string in ISO format (2023-02-13T10:08:57.307Z)

startDate

string

a date string in ISO format (2023-02-13T10:08:57.307Z)

startAt

int32

a number indicating the where the pagination should start from

perPage

int32

Defaults to 100

a number indicating the number of items per page

rangeBy

string

Defaults to createdAt

a string indicating the field to which the start and end date are applied - either 'createdAt' or 'updatedAt'

sortBy

string

Defaults to createdAt

a string indicating the field on which to sort by - either 'createdAt' or 'updatedAt'

orderBy

string

Defaults to desc

a string indicating how to order the results - either 'asc' or 'desc'

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/plain

200200