Get Directory

GET

https://api.devrev.ai/directories.get

GET

/directories.get

1 curl -G https://api.devrev.ai/directories.get \
2      -H "Authorization: Bearer <token>" \
3      -d id=id

Try it

200Retrieved

1 {
2   "directory": {
3     "id": "string",
4     "body": {
5       "id": "string",
6       "display_id": "string",
7       "file": {
8         "type": "string",
9         "name": "string",
10         "size": 1
11       }
12     },
13     "created_by": {
14       "display_id": "string",
15       "id": "string",
16       "display_name": "string",
17       "display_picture": {
18         "display_id": "string",
19         "id": "string",
20         "file": {
21           "type": "string",
22           "name": "string",
23           "size": 1
24         }
25       },
26       "email": "string",
27       "full_name": "string",
28       "state": "active"
29     },
30     "created_date": "2023-01-01T12:00:00.000Z",
31     "description": "string",
32     "display_id": "string",
33     "icon": "string",
34     "modified_by": {
35       "display_id": "string",
36       "id": "string",
37       "display_name": "string",
38       "display_picture": {
39         "display_id": "string",
40         "id": "string",
41         "file": {
42           "type": "string",
43           "name": "string",
44           "size": 1
45         }
46       },
47       "email": "string",
48       "full_name": "string",
49       "state": "active"
50     },
51     "modified_date": "2023-01-01T12:00:00.000Z",
52     "parent": {
53       "id": "string",
54       "display_id": "string",
55       "sync_metadata": {
56         "external_reference": "string",
57         "origin_system": "string"
58       }
59     },
60     "published": true,
61     "rank": "string",
62     "sync_metadata": {
63       "external_reference": "string",
64       "last_sync_in": {
65         "status": "failed",
66         "sync_date": "2023-01-01T12:00:00.000Z",
67         "sync_unit": {
68           "id": "string",
69           "display_id": "string",
70           "external_system_type": "adaas",
71           "is_archived": true,
72           "name": "string",
73           "sync_run": {
74             "mode": "initial",
75             "progress": {
76               "state": "completed"
77             }
78           },
79           "sync_type": "manual"
80         }
81       },
82       "last_sync_out": {
83         "status": "failed",
84         "sync_date": "2023-01-01T12:00:00.000Z",
85         "sync_unit": {
86           "id": "string",
87           "display_id": "string",
88           "external_system_type": "adaas",
89           "is_archived": true,
90           "name": "string",
91           "sync_run": {
92             "mode": "initial",
93             "progress": {
94               "state": "completed"
95             }
96           },
97           "sync_type": "manual"
98         }
99       },
100       "origin_system": "string"
101     },
102     "tags": [
103       {
104         "tag": {
105           "id": "string",
106           "name": "string",
107           "display_id": "string",
108           "style_new": {
109             "color": "string"
110           }
111         },
112         "value": "string"
113       }
114     ],
115     "thumbnail": {
116       "id": "string",
117       "display_id": "string",
118       "file": {
119         "type": "string",
120         "name": "string",
121         "size": 1
122       }
123     },
124     "title": "string"
125   }
126 }

Gets the specified directory.

Query parameters

idstringRequiredformat: "id"

The ID of the requested directory.

Response

Get directory response.

directoryobject

Get Directory

Headers

Query parameters

Response

Errors