Get List of Collection Points

Use this API to retrieve a list of all Collection Points or retrieve a single Collection Point using the id query parameter. By default, the response will return details of all versions of a Collection Point with the Active version listed first, but can be filtered using the status query parameter.

Query Params
uuid

Filter collection points by organization ID. Only returns collection points that belong to the specified organization or its hierarchy.

integer
β‰₯ 0
Defaults to 0

The page number of the results (0-based).

integer
1 to 100
Defaults to 20

The number of results per page.

uuid

Unique identifier of a specific Collection Point to retrieve.

string
enum

Filter Collection Points by status.

Allowed:
integer
β‰₯ 1

Filter by specific version of the Collection Point.

string
enum
Defaults to createdDate,desc

Sorting criteria in the format: property,(asc|desc). Default sort order is descending. Multiple sort criteria are supported.

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Language
Credentials
OAuth2
Missing 2 required scopes
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*