Get a collection by ID. | Scout API & SDK Reference

curl https://api.scoutos.com/v2/collections/collection_id \
     -H "Authorization: Bearer <token>"

{
  "data": {
    "collection_config": {
      "collection_display_name": "Spring Art Showcase",
      "collection_img_url": "https://example.com/images/spring-art-showcase.jpg",
      "collection_description": "A curated collection of contemporary spring-themed artworks from emerging artists.",
      "tags": [
        "art",
        "spring",
        "contemporary",
        "exhibition"
      ]
    },
    "last_updated_at": "2024-01-15T09:30:00Z",
    "created_at": "2024-01-15T09:30:00Z",
    "created_by": {
      "type": "user",
      "details": {
        "api_key": {}
      }
    },
    "last_updated_by": {
      "type": "user",
      "details": {
        "api_key": {}
      }
    },
    "collection_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "revision_id": "rev-20240115-001"
  }
}

Authentication

AuthorizationBearer

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

Path parameters

collection_idstringRequired

Response

Successful Response

dataobject or null

Errors

422

Unprocessable Entity Error

$	curl https://api.scoutos.com/v2/collections/collection_id \
>	-H "Authorization: Bearer <token>"

1	{
2	"data": {
3	"collection_config": {
4	"collection_display_name": "Spring Art Showcase",
5	"collection_img_url": "https://example.com/images/spring-art-showcase.jpg",
6	"collection_description": "A curated collection of contemporary spring-themed artworks from emerging artists.",
7	"tags": [
8	"art",
9	"spring",
10	"contemporary",
11	"exhibition"
12	]
13	},
14	"last_updated_at": "2024-01-15T09:30:00Z",
15	"created_at": "2024-01-15T09:30:00Z",
16	"created_by": {
17	"type": "user",
18	"details": {
19	"api_key": {}
20	}
21	},
22	"last_updated_by": {
23	"type": "user",
24	"details": {
25	"api_key": {}
26	}
27	},
28	"collection_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
29	"revision_id": "rev-20240115-001"
30	}
31	}