v1

latestOpenAPI 3.0.12026-07-1714724311.1 KB

Relations

List Relations

List the relations.

get/relations

Query parameters

fieldsstring[]

Control what fields are being returned in the object.

limitinteger

A limit on the number of objects that are returned.

offsetinteger

How many items to skip when fetching data.

metastring

What metadata to return in the response.

sortstring[]

How to sort the returned items. sort is a CSV of fields used to sort the fetched items. Sorting defaults to ascending (ASC) order but a minus sign (-) can be used to reverse this to descending (DESC) order. Fields are prioritized by their order in the CSV. You can also use a ? to sort randomly.

Select items in collection by given conditions.

searchstring

Filter by items that contain the given search query in one of their fields.

pageinteger

Cursor for use in pagination. Often used in combination with limit.

Response

Successful request

Example response

{
  "data": [
    {
      "id": 1,
      "many_collection": "directus_activity",
      "many_field": "user",
      "one_collection": "directus_users"
    }
  ]
}