Get Custom Object (POST)

POST

https://api.devrev.ai/custom-objects.get

POST

/custom-objects.get

1 curl -X POST https://api.devrev.ai/custom-objects.get \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

Try it

1 {
2   "custom_object": {
3     "id": "string",
4     "created_by": {
5       "display_id": "string",
6       "id": "string",
7       "display_name": "string",
8       "display_picture": {
9         "display_id": "string",
10         "id": "string",
11         "file": {
12           "type": "string",
13           "name": "string",
14           "size": 1
15         }
16       },
17       "email": "string",
18       "full_name": "string",
19       "state": "active"
20     },
21     "created_date": "2023-01-01T12:00:00.000Z",
22     "custom_fields": {},
23     "custom_schema_fragments": [
24       "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id"
25     ],
26     "display_id": "string",
27     "leaf_type": "string",
28     "modified_by": {
29       "display_id": "string",
30       "id": "string",
31       "display_name": "string",
32       "display_picture": {
33         "display_id": "string",
34         "id": "string",
35         "file": {
36           "type": "string",
37           "name": "string",
38           "size": 1
39         }
40       },
41       "email": "string",
42       "full_name": "string",
43       "state": "active"
44     },
45     "modified_date": "2023-01-01T12:00:00.000Z",
46     "stage": {
47       "stage": {
48         "id": "string",
49         "display_id": "string",
50         "name": "string"
51       },
52       "state": {
53         "id": "string",
54         "display_id": "string",
55         "is_final": true,
56         "name": "string"
57       }
58     },
59     "stock_schema_fragment": "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id",
60     "subtype": "string",
61     "sync_metadata": {
62       "external_reference": "string",
63       "last_sync_in": {
64         "status": "failed",
65         "sync_date": "2023-01-01T12:00:00.000Z",
66         "sync_unit": {
67           "id": "string",
68           "display_id": "string",
69           "external_system_type": "adaas",
70           "is_archived": true,
71           "name": "string",
72           "sync_run": {
73             "mode": "initial",
74             "progress": {
75               "state": "completed"
76             }
77           },
78           "sync_type": "manual"
79         }
80       },
81       "last_sync_out": {
82         "status": "failed",
83         "sync_date": "2023-01-01T12:00:00.000Z",
84         "sync_unit": {
85           "id": "string",
86           "display_id": "string",
87           "external_system_type": "adaas",
88           "is_archived": true,
89           "name": "string",
90           "sync_run": {
91             "mode": "initial",
92             "progress": {
93               "state": "completed"
94             }
95           },
96           "sync_type": "manual"
97         }
98       },
99       "origin_system": "string"
100     },
101     "title": "string",
102     "unique_key": "string"
103   }
104 }

Gets a custom object.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

idstringOptionalformat: "id"

The ID of the custom object to get.

Response

Success.

custom_objectobject

Headers

Request

Response

Errors