List all collections. | Scout

1 from scoutos import Scout 2 3 client = Scout( 4 api_key="YOUR_API_KEY", 5 ) 6 client.collections.list( 7 start_at="start_at", 8 limit=1, 9 query="query", 10 tags="tags", 11 sort="sort", 12 drive=True, 13 )

1 { 2 "data": [ 3 { 4 "collection_config": { 5 "collection_display_name": "Untitled", 6 "collection_img_url": "string", 7 "collection_description": "string", 8 "tags": [ 9 "string" 10 ] 11 }, 12 "last_updated_at": "2024-01-15T09:30:00Z", 13 "created_at": "2024-01-15T09:30:00Z", 14 "created_by": { 15 "type": "user", 16 "details": { 17 "api_key": {} 18 } 19 }, 20 "last_updated_by": { 21 "type": "user", 22 "details": { 23 "api_key": {} 24 } 25 }, 26 "collection_id": "string", 27 "revision_id": "string" 28 } 29 ], 30 "has_more": true, 31 "next_cursor": "string" 32 }

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

start_atstring or nullOptional

created_at to start at

limitinteger or nullOptional

Limit of records to return

querystringOptional

Search query

tagsstringOptional

Filter by tags

sortstring or nullOptional

Sort

drivebooleanOptionalDefaults to false

Response

Successful Response

datalist of objects or null

has_moreboolean or null

next_cursorstring or null

Authentication

Query parameters

Response

Errors