Get Collection

GET

https://api.webflow.com/collections/:collection_id

GET

/collections/:collection_id

$ curl https://api.webflow.com/collections/580e63fc8c9a982ac9b8b745 \
>      -H "Accept-Version: 1.0.0" \
>      -H "Authorization: Bearer <token>"

1 {
2   "_id": "580e63fc8c9a982ac9b8b745",
3   "lastUpdated": "2016-10-24T19:42:38.929Z",
4   "createdOn": "2016-10-24T19:41:48.349Z",
5   "name": "Blog Posts",
6   "slug": "post",
7   "singularName": "Blog Post",
8   "fields": [
9     {
10       "slug": "post-body",
11       "name": "Post Body",
12       "_archived": false,
13       "_draft": false,
14       "id": "7f62a9781291109b9e428fb47239fd35",
15       "editable": "true",
16       "required": "false",
17       "type": "RichText"
18     },
19     {
20       "slug": "post-summary",
21       "name": "Post Summary",
22       "_archived": false,
23       "_draft": false,
24       "id": "ac4ffead755a78c710c44042f528b073",
25       "validations": "string",
26       "helpText": "A summary of the blog post that appears on blog post grid",
27       "editable": "true",
28       "required": "false",
29       "type": "PlainText"
30     },
31     {
32       "slug": "main-image",
33       "name": "Main Image",
34       "_archived": false,
35       "_draft": false,
36       "id": "ba1cfbdaa6b38b8e95e9b5063da8a5bd",
37       "editable": "true",
38       "required": "false",
39       "type": "ImageRef"
40     },
41     {
42       "slug": "thumbnail-image",
43       "name": "Thumbnail image",
44       "_archived": false,
45       "_draft": false,
46       "id": "a8c6ea29b08cc5b5ef966908fa1deae2",
47       "helpText": "Smaller version of main image that is used on blog post grid",
48       "editable": "true",
49       "required": "false",
50       "type": "ImageRef"
51     },
52     {
53       "slug": "picture-gallery",
54       "name": "Picture Gallery",
55       "_archived": false,
56       "_draft": false,
57       "id": "87e79a644a6fb5729940ec24e0012f01",
58       "editable": "true",
59       "required": "false",
60       "type": "Set",
61       "innerType": "ImageRef"
62     },
63     {
64       "slug": "featured",
65       "name": "Featured?",
66       "_archived": false,
67       "_draft": false,
68       "id": "1e54974d97181032d3206ea021668e5f",
69       "editable": "true",
70       "required": "false",
71       "type": "Bool"
72     },
73     {
74       "slug": "color",
75       "name": "Color",
76       "_archived": false,
77       "_draft": false,
78       "id": "648463cbc042ab079c2b99430a398ae5",
79       "editable": "true",
80       "required": "false",
81       "type": "Color"
82     },
83     {
84       "slug": "author",
85       "name": "Author",
86       "_archived": false,
87       "_draft": false,
88       "id": "ea9067c48edee510de71fe503fa2fb51",
89       "validations": "string",
90       "editable": "true",
91       "required": "false",
92       "type": "ItemRef"
93     },
94     {
95       "slug": "name",
96       "name": "Name",
97       "_archived": false,
98       "_draft": false,
99       "id": "60c0667e27b6d5a6daedec3a641265f6",
100       "validations": "string",
101       "editable": "true",
102       "required": "true",
103       "type": "PlainText"
104     },
105     {
106       "slug": "slug",
107       "name": "Slug",
108       "_archived": false,
109       "_draft": false,
110       "id": "8f0c953df91d10b767d66e1d7d00d631",
111       "validations": "string",
112       "unique": "true",
113       "editable": "true",
114       "required": "true",
115       "type": "PlainText"
116     },
117     {
118       "slug": "_archived",
119       "name": "Archived",
120       "_archived": false,
121       "_draft": false,
122       "id": "e4e92e700d70faffac6fa82ff2bfaece",
123       "default": "false",
124       "editable": "true",
125       "required": "true",
126       "type": "Bool"
127     },
128     {
129       "slug": "_draft",
130       "name": "Draft",
131       "_archived": false,
132       "_draft": false,
133       "id": "f2675b2ac4fcef746b24d4a320887ef8",
134       "default": "false",
135       "editable": "true",
136       "required": "true",
137       "type": "Bool"
138     },
139     {
140       "slug": "created-on",
141       "name": "Created On",
142       "_archived": false,
143       "_draft": false,
144       "id": "0913a35d92208bdf8fbf3ed1e39b771e",
145       "editable": "false",
146       "required": "false",
147       "type": "Date"
148     },
149     {
150       "slug": "updated-on",
151       "name": "Updated On",
152       "_archived": false,
153       "_draft": false,
154       "id": "3de04889465fe6d718e47b152ef5bb4d",
155       "editable": "false",
156       "required": "false",
157       "type": "Date"
158     },
159     {
160       "slug": "published-on",
161       "name": "Published On",
162       "_archived": false,
163       "_draft": false,
164       "id": "2a3cd866d5dbb294896130b233218626",
165       "editable": "false",
166       "required": "false",
167       "type": "Date"
168     },
169     {
170       "slug": "created-by",
171       "name": "Created By",
172       "_archived": false,
173       "_draft": false,
174       "id": "62c18561b9e89517751c6d8712d48f91",
175       "editable": "false",
176       "required": "false",
177       "type": "User"
178     },
179     {
180       "slug": "updated-by",
181       "name": "Updated By",
182       "_archived": false,
183       "_draft": false,
184       "id": "50918093b4e4d4eca1e83c25bcdc06a4",
185       "editable": "false",
186       "required": "false",
187       "type": "User"
188     },
189     {
190       "slug": "published-by",
191       "name": "Published By",
192       "_archived": false,
193       "_draft": false,
194       "id": "5c4587f18b32ef245daeaadfcba7860b",
195       "editable": "false",
196       "required": "false",
197       "type": "User"
198     }
199   ]
200 }

Get a collection by collection id

Authentication

AuthorizationBearer

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

Path parameters

collection_idstringRequiredformat: "uuid"

Unique identifier for a Collection

Response

Request was successful

_idstringformat: "uuid"

Unique identifier for collection

lastUpdatedstringOptionalformat: "date-time"

The date the collection was last updated

createdOnstringOptionalformat: "date-time"

The date the collection was create

namestringOptional

Name given to Collection

slugstringOptional

Slug of Collection in Site URL structure

singularNamestringOptional

The name of one Item in Collection (e.g. “post” if the Collection is called “Posts”)

fieldslist of objectsOptional

The list of fields in the collection

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors