1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73---
title: Directus API Reference
description: Learn how to use our API
---
Each Directus project comes with an integrated RESTful API that adapts as you work on your project.
Authentication is achieved via [access tokens, cookies or sessions](/guides/auth/tokens-cookies).
You can also interact with the API using GraphQL or the [Directus SDK](/guides/connect/sdk).
This API reference is generated from our OpenAPI specification. Found an error? Please open a PR on the [directus/openapi](https://github.com/directus/openapi) repo!
## Registering and Logging in Users
::shiny-grid{class="mt-6"}
::shiny-card
---
title: Register
class: col-span-6
to: '/api/users#register-a-new-user'
---
::
::shiny-card
---
title: Login
class: col-span-6
to: '/api/authentication#login'
---
::
::
## Working with Files and Items
::shiny-grid{class="mt-6"}
::shiny-card
---
title: Upload a File
class: col-span-6
to: '/api/files#upload-a-file'
---
::
::shiny-card
---
title: Retrieve an Item
class: col-span-6
to: '/api/items#retrieve-an-item'
---
::
::
## Relational Data
::shiny-grid{class="mt-6"}
::shiny-card
---
title: Working With Relational Data
class: col-span-6
to: '/guides/connect/relations'
---
::
::
## Dynamic API
The platform's API uses database mirroring to dynamically generate
REST endpoints and a GraphQL schema based on the connected database's architecture. Since these endpoints return data
based on your specific schema and configured permissions, the input/output of the API differs greatly for individual
installations.