Get Collection Details

GET

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

GET

/v2/collections/:collection_id

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

1 {
2   "id": "7f15043107e2fc95644e93807ee25dd6",
3   "displayName": "Guide Entries",
4   "singularName": "Guide Entry",
5   "fields": [
6     {
7       "id": "5e2a1b3c4d5e6f7890a1b2c3",
8       "isRequired": true,
9       "type": "PlainText",
10       "displayName": "Entry Title",
11       "isEditable": true,
12       "slug": "name",
13       "helpText": "Name of the entry.",
14       "validations": null
15     },
16     {
17       "id": "5e2a1b3c4d5e6f7890a1b2c4",
18       "isRequired": true,
19       "type": "PlainText",
20       "displayName": "Slug",
21       "isEditable": true,
22       "slug": "slug",
23       "helpText": "Slug of the entry.",
24       "validations": null
25     },
26     {
27       "id": "6f7e8d9c0b1a2e3d4c5b6a7f",
28       "isRequired": false,
29       "type": "PlainText",
30       "displayName": "Summary",
31       "isEditable": true,
32       "slug": "summary",
33       "helpText": "A short summary of the entry.",
34       "validations": null
35     },
36     {
37       "id": "1a2b3c4d5e6f7a8b9c0d1e2f",
38       "isRequired": false,
39       "type": "RichText",
40       "displayName": "Entry HTML",
41       "isEditable": true,
42       "slug": "entry-html",
43       "helpText": "The HTML content of the entry.",
44       "validations": null
45     },
46     {
47       "id": "7e8d9c0b1a2e3d4c5b6a7f8e",
48       "isRequired": false,
49       "type": "Image",
50       "displayName": "Illustration Image",
51       "isEditable": true,
52       "slug": "illustration-image",
53       "helpText": "An image of the entry.",
54       "validations": null
55     },
56     {
57       "id": "2f3e4d5c6b7a8e9d0c1b2a3f",
58       "isRequired": false,
59       "type": "VideoLink",
60       "displayName": "Demonstration Video",
61       "isEditable": true,
62       "slug": "demonstration-video",
63       "helpText": "A video of the entry.",
64       "validations": null
65     },
66     {
67       "id": "8e9d0c1b2a3f4e5d6c7b8a9e",
68       "isRequired": false,
69       "type": "Link",
70       "displayName": "More Info Link",
71       "isEditable": true,
72       "slug": "more-info-link",
73       "helpText": "A link to more information about the entry.",
74       "validations": null
75     },
76     {
77       "id": "3f4e5d6c7b8a9e0d1c2b3a4f",
78       "isRequired": false,
79       "type": "Number",
80       "displayName": "Importance Level",
81       "isEditable": true,
82       "slug": "importance-level",
83       "helpText": "The importance level of the entry.",
84       "validations": {
85         "format": "integer",
86         "allowNegative": false,
87         "allowZero": false,
88         "minValue": 1,
89         "maxValue": 5
90       }
91     },
92     {
93       "id": "9e0d1c2b3a4f5e6d7c8b9a0e",
94       "isRequired": false,
95       "type": "Switch",
96       "displayName": "Is Essential",
97       "isEditable": true,
98       "slug": "is-essential",
99       "helpText": "Is this entry essential?",
100       "validations": null
101     },
102     {
103       "id": "4f5e6d7c8b9a0e1d2c3b4a5f",
104       "isRequired": false,
105       "type": "DateTime",
106       "displayName": "First Mentioned",
107       "isEditable": true,
108       "slug": "first-mentioned",
109       "helpText": "Date of the first mention of the subject.",
110       "validations": null
111     },
112     {
113       "id": "0e1d2c3b4a5f6e7d8c9b0a1e",
114       "isRequired": false,
115       "type": "Color",
116       "displayName": "Towel Color",
117       "isEditable": true,
118       "slug": "towel-color",
119       "helpText": "The color of the towel.",
120       "validations": null
121     },
122     {
123       "id": "5f6e7d8c9b0a1e2d3c4b5a6f",
124       "isRequired": false,
125       "type": "Reference",
126       "displayName": "Related Entry",
127       "isEditable": true,
128       "slug": "related-entry",
129       "helpText": "A related entry.",
130       "validations": {
131         "collectionId": "7f15043107e2fc95644e93807ee25dd6"
132       }
133     },
134     {
135       "id": "1e2d3c4b5a6f7e8d9c0b1a2f",
136       "isRequired": false,
137       "type": "MultiReference",
138       "displayName": "Mentioned In Entries",
139       "isEditable": true,
140       "slug": "mentioned-in-entries",
141       "helpText": "Entries that mention this subject.",
142       "validations": {
143         "collectionId": "7f15043107e2fc95644e93807ee25dd6"
144       }
145     },
146     {
147       "id": "6f7e8d9c0b1a2e3d4c5b6a8f",
148       "isRequired": false,
149       "type": "Option",
150       "displayName": "Item Type",
151       "isEditable": true,
152       "slug": "item-type",
153       "helpText": "The type of item.",
154       "validations": {
155         "options": [
156           {
157             "name": "Survival Gear",
158             "id": "66f6e966c9e1dc700a857ca3"
159           },
160           {
161             "name": "Gadget",
162             "id": "66f6e966c9e1dc700a857ca4"
163           },
164           {
165             "name": "Other",
166             "id": "66f6e966c9e1dc700a857ca5"
167           }
168         ]
169       }
170     },
171     {
172       "id": "2e3d4c5b6a7f8e9d0c1b2a4f",
173       "isRequired": false,
174       "type": "File",
175       "displayName": "Guide File",
176       "isEditable": true,
177       "slug": "guide-file",
178       "validations": null
179     },
180     {
181       "id": "7f8e9d0c1b2a3f4e5d6c8b9e",
182       "isRequired": false,
183       "type": "Email",
184       "displayName": "Contributor Email",
185       "isEditable": true,
186       "slug": "contributor-email",
187       "validations": null
188     },
189     {
190       "id": "3a4f5e6d7c8b9a0e1d2c4b5f",
191       "isRequired": false,
192       "type": "Phone",
193       "displayName": "Emergency Contact",
194       "isEditable": true,
195       "slug": "emergency-contact",
196       "validations": null
197     }
198   ],
199   "slug": "guide-entry",
200   "createdOn": "2024-04-12T12:42:00.000Z",
201   "lastUpdated": "2024-04-12T12:42:00.000Z"
202 }

Get the full details of a collection from its ID.

Required scope | cms:read

Authentication

AuthorizationBearer

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

Path parameters

collection_idstringRequiredformat: "objectid"

Unique identifier for a Collection

Response

Request was successful

idstringformat: "objectid"

Unique identifier for a Collection

displayNamestring

Name given to the Collection

singularNamestring

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

fieldslist of objects

The list of fields in the Collection

slugstring

Slug of Collection in Site URL structure

createdOnstringRead-onlyformat: "date-time"

The date the collection was created

lastUpdatedstringRead-onlyformat: "date-time"

The date the collection was last updated

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error