Get referenced entities for a fragment

GET

https://api.contentful.com/spaces/:spaceId/environments/:environmentId/fragments/:id/references

GET

/spaces/:spaceId/environments/:environmentId/fragments/:id/references

$ curl https://api.contentful.com/spaces/spaceId/environments/environmentId/fragments/id/references \
>      -H "Authorization: Bearer <token>"

1 {
2   "sys": {
3     "type": "string"
4   },
5   "items": [
6     {
7       "sys": {
8         "id": "string",
9         "type": "string",
10         "space": {
11           "sys": {
12             "type": "string",
13             "linkType": "string",
14             "id": "string"
15           }
16         },
17         "environment": {
18           "sys": {
19             "type": "string",
20             "linkType": "string",
21             "id": "string"
22           }
23         },
24         "componentType": {
25           "sys": {
26             "type": "string",
27             "linkType": "string",
28             "urn": "string"
29           }
30         },
31         "createdAt": "string",
32         "updatedAt": "string",
33         "createdBy": {
34           "sys": {
35             "type": "string",
36             "linkType": "string",
37             "id": "string"
38           }
39         },
40         "updatedBy": {
41           "sys": {
42             "type": "string",
43             "linkType": "string",
44             "id": "string"
45           }
46         },
47         "version": 1.1,
48         "archivedAt": "string",
49         "archivedBy": {
50           "sys": {
51             "type": "string",
52             "linkType": "string",
53             "id": "string"
54           }
55         },
56         "archivedVersion": 1.1,
57         "variant": "string",
58         "variantType": "string",
59         "variantDimension": "string",
60         "publishedAt": "string",
61         "publishedVersion": 1.1,
62         "publishedCounter": 1.1,
63         "firstPublishedAt": "string",
64         "publishedBy": {
65           "sys": {
66             "type": "string",
67             "linkType": "User",
68             "id": "string"
69           }
70         }
71       },
72       "name": "string",
73       "description": "string",
74       "viewports": [
75         {
76           "id": "string",
77           "query": "string",
78           "displayName": "string",
79           "previewSize": "string"
80         }
81       ],
82       "designProperties": {},
83       "dimensionKeyMap": {
84         "designProperties": {}
85       },
86       "contentBindings": {
87         "sys": {
88           "type": "string",
89           "linkType": "string",
90           "urn": "string"
91         },
92         "parameters": {}
93       },
94       "metadata": {
95         "tags": [
96           {
97             "sys": {
98               "type": "string",
99               "linkType": "string",
100               "id": "string"
101             }
102           }
103         ],
104         "concepts": [
105           {
106             "sys": {
107               "type": "string",
108               "linkType": "string",
109               "id": "string"
110             }
111           }
112         ],
113         "name": "string"
114       },
115       "slots": {}
116     }
117   ],
118   "includes": {
119     "Entry": [
120       {
121         "sys": {
122           "id": "string",
123           "type": "string",
124           "contentType": {
125             "sys": {
126               "type": "string",
127               "linkType": "string",
128               "id": "string"
129             }
130           }
131         },
132         "fields": {}
133       }
134     ],
135     "Asset": [
136       {
137         "sys": {
138           "id": "string",
139           "type": "string"
140         },
141         "fields": {
142           "title": {},
143           "file": {},
144           "description": {}
145         }
146       }
147     ],
148     "DataAssembly": [
149       {
150         "sys": {
151           "id": "string",
152           "type": "string",
153           "dataType": [
154             {
155               "name": "string",
156               "required": true,
157               "type": "String",
158               "id": "string"
159             }
160           ],
161           "version": 1.1,
162           "space": {
163             "sys": {
164               "type": "string",
165               "linkType": "string",
166               "id": "string"
167             }
168           },
169           "environment": {
170             "sys": {
171               "type": "string",
172               "linkType": "string",
173               "id": "string"
174             }
175           },
176           "createdBy": {
177             "sys": {
178               "type": "string",
179               "linkType": "string",
180               "id": "string"
181             }
182           },
183           "updatedBy": {
184             "sys": {
185               "type": "string",
186               "linkType": "string",
187               "id": "string"
188             }
189           },
190           "publishedVersion": 1.1,
191           "publishedCounter": 1.1,
192           "publishedBy": {
193             "sys": {
194               "type": "string",
195               "linkType": "string",
196               "id": "string"
197             }
198           },
199           "variant": "string"
200         },
201         "metadata": {
202           "tags": [
203             {
204               "sys": {
205                 "type": "string",
206                 "linkType": "string",
207                 "id": "string"
208               }
209             }
210           ]
211         },
212         "name": "string",
213         "description": "string",
214         "parameters": {},
215         "resolvers": {},
216         "return": {
217           "$literal": {}
218         }
219       }
220     ],
221     "ComponentType": [
222       {
223         "sys": {
224           "id": "string",
225           "type": "string",
226           "space": {
227             "sys": {
228               "type": "string",
229               "linkType": "string",
230               "id": "string"
231             }
232           },
233           "environment": {
234             "sys": {
235               "type": "string",
236               "linkType": "string",
237               "id": "string"
238             }
239           },
240           "version": 1.1,
241           "createdAt": "string",
242           "createdBy": {
243             "sys": {
244               "type": "string",
245               "linkType": "string",
246               "id": "string"
247             }
248           },
249           "updatedAt": "string",
250           "updatedBy": {
251             "sys": {
252               "type": "string",
253               "linkType": "string",
254               "id": "string"
255             }
256           },
257           "fieldStatus": {},
258           "publishedAt": "string",
259           "publishedVersion": 1.1,
260           "publishedCounter": 1.1,
261           "firstPublishedAt": "string",
262           "publishedBy": {
263             "sys": {
264               "type": "string",
265               "linkType": "User",
266               "id": "string"
267             }
268           },
269           "variant": "string",
270           "variantType": "string",
271           "variantDimension": "string"
272         },
273         "name": "string",
274         "description": "string",
275         "viewports": [
276           {
277             "id": "string",
278             "query": "string",
279             "displayName": "string",
280             "previewSize": "string"
281           }
282         ],
283         "contentProperties": [
284           {
285             "name": "string",
286             "required": true,
287             "type": "String",
288             "id": "string"
289           }
290         ],
291         "designProperties": [
292           {
293             "id": "string",
294             "name": "string",
295             "description": "string",
296             "type": "string",
297             "fallbackValue": {
298               "type": "string",
299               "value": "string"
300             },
301             "validations": [
302               {
303                 "regexp": {
304                   "pattern": "string"
305                 }
306               }
307             ]
308           }
309         ],
310         "dimensionKeyMap": {
311           "designProperties": {}
312         },
313         "componentTree": [
314           {
315             "id": "string",
316             "nodeType": "string",
317             "componentType": {
318               "sys": {
319                 "type": "string",
320                 "linkType": "string",
321                 "urn": "string"
322               }
323             },
324             "contentProperties": {},
325             "designProperties": {},
326             "slots": {},
327             "name": "string"
328           }
329         ],
330         "slots": [
331           {
332             "id": "string",
333             "name": "string",
334             "required": true,
335             "validations": [
336               {
337                 "size": {
338                   "min": 1.1,
339                   "max": 1.1
340                 }
341               }
342             ],
343             "allowedResources": [
344               {
345                 "type": "string",
346                 "source": "string",
347                 "allowedTypes": [
348                   "string"
349                 ]
350               }
351             ]
352           }
353         ],
354         "metadata": {
355           "tags": [
356             {
357               "sys": {
358                 "type": "string",
359                 "linkType": "string",
360                 "id": "string"
361               }
362             }
363           ],
364           "concepts": [
365             {
366               "sys": {
367                 "type": "string",
368                 "linkType": "string",
369                 "id": "string"
370               }
371             }
372           ]
373         },
374         "dataAssemblies": [
375           {
376             "sys": {
377               "type": "string",
378               "linkType": "string",
379               "urn": "string"
380             }
381           }
382         ],
383         "source": {
384           "sys": {
385             "type": "string",
386             "linkType": "string",
387             "urn": "string"
388           }
389         }
390       }
391     ],
392     "Template": [
393       {
394         "sys": {
395           "id": "string",
396           "type": "string",
397           "space": {
398             "sys": {
399               "type": "string",
400               "linkType": "string",
401               "id": "string"
402             }
403           },
404           "environment": {
405             "sys": {
406               "type": "string",
407               "linkType": "string",
408               "id": "string"
409             }
410           },
411           "version": 1.1,
412           "createdAt": "string",
413           "createdBy": {
414             "sys": {
415               "type": "string",
416               "linkType": "string",
417               "id": "string"
418             }
419           },
420           "updatedAt": "string",
421           "updatedBy": {
422             "sys": {
423               "type": "string",
424               "linkType": "string",
425               "id": "string"
426             }
427           },
428           "fieldStatus": {},
429           "publishedAt": "string",
430           "publishedVersion": 1.1,
431           "publishedCounter": 1.1,
432           "firstPublishedAt": "string",
433           "publishedBy": {
434             "sys": {
435               "type": "string",
436               "linkType": "User",
437               "id": "string"
438             }
439           },
440           "variant": "string",
441           "variantType": "string",
442           "variantDimension": "string"
443         },
444         "name": "string",
445         "description": "string",
446         "viewports": [
447           {
448             "id": "string",
449             "query": "string",
450             "displayName": "string",
451             "previewSize": "string"
452           }
453         ],
454         "contentProperties": [
455           {
456             "name": "string",
457             "required": true,
458             "type": "String",
459             "id": "string"
460           }
461         ],
462         "designProperties": [
463           {
464             "id": "string",
465             "name": "string",
466             "description": "string",
467             "type": "string",
468             "fallbackValue": {
469               "type": "string",
470               "value": "string"
471             },
472             "validations": [
473               {
474                 "regexp": {
475                   "pattern": "string"
476                 }
477               }
478             ]
479           }
480         ],
481         "dimensionKeyMap": {
482           "designProperties": {}
483         },
484         "componentTree": [
485           {
486             "id": "string",
487             "nodeType": "string",
488             "componentType": {
489               "sys": {
490                 "type": "string",
491                 "linkType": "string",
492                 "urn": "string"
493               }
494             },
495             "contentProperties": {},
496             "designProperties": {},
497             "slots": {},
498             "name": "string"
499           }
500         ],
501         "slots": [
502           {
503             "id": "string",
504             "name": "string",
505             "required": true,
506             "validations": [
507               {
508                 "size": {
509                   "min": 1.1,
510                   "max": 1.1
511                 }
512               }
513             ],
514             "allowedResources": [
515               {
516                 "type": "string",
517                 "source": "string",
518                 "allowedTypes": [
519                   "string"
520                 ]
521               }
522             ]
523           }
524         ],
525         "metadata": {
526           "tags": [
527             {
528               "sys": {
529                 "type": "string",
530                 "linkType": "string",
531                 "id": "string"
532               }
533             }
534           ],
535           "concepts": [
536             {
537               "sys": {
538                 "type": "string",
539                 "linkType": "string",
540                 "id": "string"
541               }
542             }
543           ]
544         },
545         "dataAssemblies": [
546           {
547             "sys": {
548               "type": "string",
549               "linkType": "string",
550               "urn": "string"
551             }
552           }
553         ]
554       }
555     ],
556     "Fragment": [
557       {
558         "sys": {
559           "id": "string",
560           "type": "string",
561           "space": {
562             "sys": {
563               "type": "string",
564               "linkType": "string",
565               "id": "string"
566             }
567           },
568           "environment": {
569             "sys": {
570               "type": "string",
571               "linkType": "string",
572               "id": "string"
573             }
574           },
575           "componentType": {
576             "sys": {
577               "type": "string",
578               "linkType": "string",
579               "urn": "string"
580             }
581           },
582           "createdAt": "string",
583           "updatedAt": "string",
584           "createdBy": {
585             "sys": {
586               "type": "string",
587               "linkType": "string",
588               "id": "string"
589             }
590           },
591           "updatedBy": {
592             "sys": {
593               "type": "string",
594               "linkType": "string",
595               "id": "string"
596             }
597           },
598           "version": 1.1,
599           "archivedAt": "string",
600           "archivedBy": {
601             "sys": {
602               "type": "string",
603               "linkType": "string",
604               "id": "string"
605             }
606           },
607           "archivedVersion": 1.1,
608           "variant": "string",
609           "variantType": "string",
610           "variantDimension": "string",
611           "publishedAt": "string",
612           "publishedVersion": 1.1,
613           "publishedCounter": 1.1,
614           "firstPublishedAt": "string",
615           "publishedBy": {
616             "sys": {
617               "type": "string",
618               "linkType": "User",
619               "id": "string"
620             }
621           }
622         },
623         "name": "string",
624         "description": "string",
625         "viewports": [
626           {
627             "id": "string",
628             "query": "string",
629             "displayName": "string",
630             "previewSize": "string"
631           }
632         ],
633         "designProperties": {},
634         "dimensionKeyMap": {
635           "designProperties": {}
636         },
637         "contentBindings": {
638           "sys": {
639             "type": "string",
640             "linkType": "string",
641             "urn": "string"
642           },
643           "parameters": {}
644         },
645         "metadata": {
646           "tags": [
647             {
648               "sys": {
649                 "type": "string",
650                 "linkType": "string",
651                 "id": "string"
652               }
653             }
654           ],
655           "concepts": [
656             {
657               "sys": {
658                 "type": "string",
659                 "linkType": "string",
660                 "id": "string"
661               }
662             }
663           ],
664           "name": "string"
665         },
666         "slots": {}
667       }
668     ]
669   }
670 }

Authentication

AuthorizationBearer

Contentful Management API token

Path parameters

spaceIdstringRequired

environmentIdstringRequired

idstringRequired

Query parameters

access_tokenstringOptional

Response

200

sysobject

itemslist of objects

includesobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

500

Internal Server Error