Export Post

POST

Exports a collection of accounts.

Request

This endpoint expects an object.

created_bylist of stringsOptional

Filters for accounts created by the specified user(s).

created_dateobjectOptional

custom_fieldsmap from strings to anyOptional

Filters for custom fields.

display_namelist of stringsOptional

Array of display names of accounts to be filtered.

domainslist of stringsOptional

Domains for accounts to be filtered.

external_refslist of stringsOptional

Array of references of accounts to be filtered.

firstintegerOptional>=1<=500

The number of accounts to return. The default is ‘50’.

modified_dateobjectOptional

owned_bylist of stringsOptional

Filters for accounts owned by the specified user(s).

sort_bylist of stringsOptional

Fields to sort the accounts by and the direction to sort them in.

stagelist of stringsOptional

Filters for accounts on specified stages.

tagslist of stringsOptional

List of tags to be filtered.

Response

This endpoint returns an object.

accountslist of objects

The exported accounts.

POST

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

200Successful

1 {
2   "accounts": [
3     {
4       "external_refs": [
5         "external_refs"
6       ],
7       "id": "id",
8       "owned_by": [
9         {
10           "type": "sys_user",
11           "id": "owned_by"
12         }
13       ],
14       "artifacts": [
15         {
16           "id": "id"
17         }
18       ],
19       "created_by": {
20         "type": "sys_user",
21         "id": "created_by"
22       },
23       "created_date": "2023-01-01T12:00:00Z",
24       "custom_fields": {
25         "key": "value"
26       },
27       "custom_schema_fragments": [
28         "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
29       ],
30       "description": "description",
31       "display_id": "display_id",
32       "display_name": "display_name",
33       "domains": [
34         "domains"
35       ],
36       "modified_by": {
37         "type": "sys_user",
38         "id": "modified_by"
39       },
40       "modified_date": "2023-01-01T12:00:00Z",
41       "stock_schema_fragment": "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>",
42       "subtype": "subtype",
43       "tags": [
44         {
45           "tag": {
46             "id": "id",
47             "name": "name"
48           }
49         }
50       ],
51       "tier": "tier"
52     }
53   ]
54 }

Built with

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

1	{
2	"accounts": [
3	{
4	"external_refs": [
5	"external_refs"
6	],
7	"id": "id",
8	"owned_by": [
9	{
10	"type": "sys_user",
11	"id": "owned_by"
12	}
13	],
14	"artifacts": [
15	{
16	"id": "id"
17	}
18	],
19	"created_by": {
20	"type": "sys_user",
21	"id": "created_by"
22	},
23	"created_date": "2023-01-01T12:00:00Z",
24	"custom_fields": {
25	"key": "value"
26	},
27	"custom_schema_fragments": [
28	"don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
29	],
30	"description": "description",
31	"display_id": "display_id",
32	"display_name": "display_name",
33	"domains": [
34	"domains"
35	],
36	"modified_by": {
37	"type": "sys_user",
38	"id": "modified_by"
39	},
40	"modified_date": "2023-01-01T12:00:00Z",
41	"stock_schema_fragment": "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>",
42	"subtype": "subtype",
43	"tags": [
44	{
45	"tag": {
46	"id": "id",
47	"name": "name"
48	}
49	}
50	],
51	"tier": "tier"
52	}
53	]
54	}