• About
    • For Developers
  • API Reference
    • Changelog
  • Guides
    • Account creation
    • Agents async API
    • Links
API Referenceaccounts

Export Accounts

GET
https://api.devrev.ai/accounts.export
GET
/accounts.export
1curl https://api.devrev.ai/accounts.export \
2     -H "Authorization: Bearer <token>"
Try it
200Retrieved
1{
2  "accounts": [
3    {
4      "id": "string",
5      "owned_by": [
6        {
7          "display_id": "string",
8          "id": "string",
9          "display_name": "string",
10          "display_picture": {
11            "display_id": "string",
12            "id": "string",
13            "file": {
14              "type": "string",
15              "name": "string",
16              "size": 1
17            }
18          },
19          "email": "string",
20          "full_name": "string",
21          "state": "active"
22        }
23      ],
24      "artifacts": [
25        {
26          "id": "string",
27          "display_id": "string",
28          "file": {
29            "type": "string",
30            "name": "string",
31            "size": 1
32          }
33        }
34      ],
35      "created_by": {
36        "display_id": "string",
37        "id": "string",
38        "display_name": "string",
39        "display_picture": {
40          "display_id": "string",
41          "id": "string",
42          "file": {
43            "type": "string",
44            "name": "string",
45            "size": 1
46          }
47        },
48        "email": "string",
49        "full_name": "string",
50        "state": "active"
51      },
52      "created_date": "2023-01-01T12:00:00.000Z",
53      "custom_fields": {},
54      "custom_schema_fragments": [
55        "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id"
56      ],
57      "description": "string",
58      "display_id": "string",
59      "display_name": "string",
60      "domains": [
61        "string"
62      ],
63      "external_refs": [
64        "string"
65      ],
66      "modified_by": {
67        "display_id": "string",
68        "id": "string",
69        "display_name": "string",
70        "display_picture": {
71          "display_id": "string",
72          "id": "string",
73          "file": {
74            "type": "string",
75            "name": "string",
76            "size": 1
77          }
78        },
79        "email": "string",
80        "full_name": "string",
81        "state": "active"
82      },
83      "modified_date": "2023-01-01T12:00:00.000Z",
84      "primary_account": {
85        "id": "string",
86        "display_id": "string",
87        "display_name": "string"
88      },
89      "stock_schema_fragment": "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id",
90      "subtype": "string",
91      "tags": [
92        {
93          "tag": {
94            "id": "string",
95            "name": "string",
96            "display_id": "string",
97            "style_new": {
98              "color": "string"
99            }
100          },
101          "value": "string"
102        }
103      ],
104      "tier": "string",
105      "websites": [
106        "string"
107      ]
108    }
109  ]
110}
Exports a collection of accounts.

Headers

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

Query parameters

created_bylist of stringsOptional
Filters for accounts created by the specified user(s).
created_date.afterstringOptionalformat: "date-time"
Filters for objects created after the provided timestamp (inclusive).
created_date.beforestringOptionalformat: "date-time"
Filters for objects created before the provided timestamp (inclusive).
custom_fieldsobjectOptional
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_date.afterstringOptionalformat: "date-time"
Filters for objects created after the provided timestamp (inclusive).
modified_date.beforestringOptionalformat: "date-time"
Filters for objects created before the provided timestamp (inclusive).
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.
subtypelist of stringsOptional
Subtypes of the accounts to be filtered.
tagslist of stringsOptional
List of tags to be filtered.
tierlist of stringsOptional
Tier of the accounts to be filtered.
websiteslist of stringsOptional
Array of websites of accounts to be filtered.

Response

The response to exporting a collection of accounts.
accountslist of objects
The exported accounts.

Errors

Was this page helpful?
Previous

Export Accounts (POST)

Next
Built with
Filters for custom fields.
Array of display names of accounts to be filtered.
Domains for accounts to be filtered.
Array of references of accounts to be filtered.
The number of accounts to return. The default is '50'.
Fields to sort the accounts by and the direction to sort them in.
Filters for accounts on specified stages.
Subtypes of the accounts to be filtered.
List of tags to be filtered.
Tier of the accounts to be filtered.
Array of websites of accounts to be filtered.
The response to exporting a collection of accounts.

Export Accounts (POST)

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

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

Filters for objects created after the provided timestamp (inclusive).

Filters for objects created after the provided timestamp (inclusive).

Filters for objects created before the provided timestamp (inclusive).

Filters for objects created before the provided timestamp (inclusive).

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