List all collections.

Beta

GET

https://api-prod.scoutos.com/v2/collections

GET

/v2/collections

1 from scoutos import Scout
2 
3 client = Scout(
4     api_key="YOUR_API_KEY",
5 )
6 client.collections.list()

Try it

200Retrieved

1 {
2   "data": [
3     {
4       "collection_config": {
5         "collection_display_name": "Untitled",
6         "collection_img_url": "collection_img_url",
7         "collection_description": "collection_description"
8       },
9       "last_updated_at": "last_updated_at",
10       "created_at": "created_at",
11       "created_by": {
12         "type": "user",
13         "details": {
14           "user_id": "user_id",
15           "org_id": "org_id",
16           "scout_organization_id": "scout_organization_id",
17           "email": {}
18         }
19       },
20       "last_updated_by": {
21         "type": "user",
22         "details": {
23           "user_id": "user_id",
24           "org_id": "org_id",
25           "scout_organization_id": "scout_organization_id",
26           "email": {}
27         }
28       },
29       "collection_id": "collection_id",
30       "revision_id": "revision_id"
31     }
32   ],
33   "has_more": false,
34   "next_cursor": "next_cursor"
35 }

Query parameters

start_atstring or nullOptional

created_at to start at

limitinteger or nullOptional

Limit of records to return

querystringOptional

Search query

Response

Successful Response

datalist of objects or null

has_moreboolean or null

next_cursorstring or null

List all collections.

Headers

Query parameters

Response

Errors