Relations
List Relations
List all relations that exist in Directus. The data returned in this endpoint will be filtered based on the user's permissions. For example, relations that apply to a collection that the current user doesn't have access to are stripped out.
Query Parameters
Control what fields are being returned in the object.
A limit on the number of objects that are returned.
How many items to skip when fetching data.
What metadata to return in the response.
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.
Filter by items that contain the given search query in one of their fields.
Cursor for use in pagination. Often used in combination with limit.
200 Response
Successful request
GET /relations
{
"data": [
{
"collection": "directus_collections",
"field": "group",
"related_collection": "directus_collections",
"schema": {
"table": "directus_collections",
"column": "group",
"foreign_key_table": "directus_collections",
"foreign_key_column": "collection",
"on_update": "NO ACTION",
"on_delete": "NO ACTION",
"constraint_name": null
},
"meta": {
"many_collection": "directus_collections",
"many_field": "group",
"one_collection": "directus_collections",
"one_field": null,
"one_allowed_collections": null,
"one_collection_field": null,
"one_deselect_action": "nullify",
"junction_field": null,
"sort_field": null,
"system": true
}
}
]
}
Create a Relation
Create a new relation.
Query Parameters
Control what fields are being returned in the object.
What metadata to return in the response.
Request Body
Collection that has the field that holds the foreign key.
Collection on the one side of the relationship.
Foreign key. Field that holds the primary key of the related collection.
Alias column that serves as the one side of the relationship.
Field on the junction table that holds the primary key of the related collection.
POST /relations
{
"data": {
"id": 1,
"many_collection": "directus_activity",
"many_field": "user",
"one_collection": "directus_users",
"one_field": null,
"one_allowed_collections": [],
"junction_field": null
}
}
List relations in collection
List all relations that exist in a given collection.
Query Parameters
Unique identifier of the collection the relations reside in.
POST /relations/{collection}
{
"data": [
{
"id": 1,
"many_collection": "directus_activity",
"many_field": "user",
"one_collection": "directus_users",
"one_field": null,
"one_allowed_collections": [],
"junction_field": null
}
]
}
Retrieve a Relation
Retrieve a single relation by unique identifier.
Query Parameters
Identifier for the object.
Control what fields are being returned in the object.
What metadata to return in the response.
GET /relations/{id}
{
"data": {
"id": 1,
"many_collection": "directus_activity",
"many_field": "user",
"one_collection": "directus_users",
"one_field": null,
"one_allowed_collections": [],
"junction_field": null
}
}
Delete a Relation
Delete an existing relation.
Query Parameters
Identifier for the object.
204 Response
The resource was deleted successfully.
DELETE /relations/{id}
Update a Relation
Update an existing relation.
Query Parameters
Identifier for the object.
Control what fields are being returned in the object.
What metadata to return in the response.
Request Body
Collection that has the field that holds the foreign key.
Collection on the one side of the relationship.
Foreign key. Field that holds the primary key of the related collection.
Alias column that serves as the one side of the relationship.
Field on the junction table that holds the primary key of the related collection.
PATCH /relations/{id}
{
"data": {
"id": 1,
"many_collection": "directus_activity",
"many_field": "user",
"one_collection": "directus_users",
"one_field": null,
"one_allowed_collections": [],
"junction_field": null
}
}