Relationships

Gets the relationships for a given entity type

Gets the relationships for a given entity type

get/api/v1/relationships

Request

  • Base URL: https://uniform.app
  • URL: https://uniform.app/api/v1/relationships
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Query parameters

projectIdstring required
type'component' | 'contentType' | 'blockType' | 'asset' | 'componentPattern' | 'entryPattern' | 'compositionPattern' | 'entry' | 'dataType' | 'dataSource' | 'test' required
idsstring[] required

Entity IDs

withInstancesboolean nullable

Whether to include a list of related instances in the response. Only supported when a single entity ID is provided

limitnumber

Use this to paginate over the instances when "whenInstances" is true

offsetnumber nullable

Use this to paginate over the instances when "whenInstances" is true

Response

200 response

idstring required
totalCountnumber required

Changes

No recorded changes to this operation across all 1 revision of this API.