directus/docs/reference/system/revisions.md

description, readTime, pageClass

description	readTime	pageClass
REST and GraphQL API documentation on the Revisions collection in Directus.	2 min read	page-reference

Revisions

Revisions are individual changes to items made. Directus keeps track of changes made, so you're able to revert to a previous state at will. Learn more about Revisions.

The Revision Object

id integer
Primary key of the revision.

activity many-to-one
Related activity record. Many-to-one to activity.

collection string
Collection in which this revision happened.

item string
Primary key of the item that was changed.

data object
Snapshot of the top-level item data.

delta object
Snapshot of the changes made in this revision.

parent many-to-one
Parent revision that triggered this revision. Many-to-one to revisions (recursive).

{
	"id": 368,
	"activity": 438,
	"collection": "articles",
	"item": "1",
	"data": {
		"title": "Hello World"
	},
	"delta": {
		"title": "Hello from the Docs!"
	},
	"parent": null
}

List revisions

List all revisions that exist in Directus.

::: tip Permissions

The data returned in this endpoint will be filtered based on the user's permissions. For example, revisions that apply to a collection that the current user doesn't have access to are stripped out.

:::

Request

GET /revisions

SEARCH /revisions

POST /graphql/system

type Query {
	revisions: [directus_revisions]
}

import { createDirectus } from '@directus/sdk';
import { rest, readRevisions } from '@directus/sdk/rest';

const client = createDirectus('https://directus.example.com').with(rest());

const result = await client.request(
	readRevisions({
		fields: ['*'],
	})
);

Learn more about SEARCH ->

Query Parameters

Supports all global query parameters.

Response

An array of up to limit revision objects. If no items are available, data will be an empty array.

Examples

GET /revisions

SEARCH /revisions

POST /graphql/system

query {
	revisions {
		id
		data
		delta
	}
}

import { createDirectus } from '@directus/sdk';
import { rest, readRevisions } from '@directus/sdk/rest';

const client = createDirectus('https://directus.example.com').with(rest());

const result = await client.request(
	readRevisions({
		fields: ['*'],
	})
);

Retrieve a revision

List an existing revision by primary key.

Request

GET /revisions/:id

POST /graphql/system

type Query {
	revisions_by_id(id: ID!): directus_revisions
}

import { createDirectus } from '@directus/sdk';
import { rest, readRevision } from '@directus/sdk/rest';

const client = createDirectus('https://directus.example.com').with(rest());

const result = await client.request(
	readRevision('revision_id', {
		fields: ['*'],
	})
);

Query Parameters

Supports all global query parameters.

Response

Returns the requested revision object.

Example

GET /revisions/322

POST /graphql/system

query {
	revisions_by_id(id: 322) {
		id
		data
		delta
	}
}

import { createDirectus } from '@directus/sdk';
import { rest, readRevision } from '@directus/sdk/rest';

const client = createDirectus('https://directus.example.com').with(rest());

const result = await client.request(
	readRevision('53201', {
		fields: ['*'],
	})
);