Beta

Get a collection by ID.

GET

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

Play

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

Path parameters

collection_idstringRequired

Response

Successful Response

dataobjectOptional

Get a collection by ID.

Path parameters

Headers

Response

Errors