accounts

Export

GET
Exports a collection of accounts.

Query parameters

created_bystringOptional
Filters for accounts created by the specified user(s).
created_date.afterdatetimeOptional
Filters for objects created after the provided timestamp (inclusive).
created_date.beforedatetimeOptional
Filters for objects created before the provided timestamp (inclusive).
custom_fieldsmap from strings to anyOptional
Filters for custom fields.
display_namestringOptional
Array of display names of accounts to be filtered.
domainsstringOptional
Domains for accounts to be filtered.
external_refsstringOptional
Array of references of accounts to be filtered.
firstintegerOptional
The number of accounts to return. The default is '50'.
modified_date.afterdatetimeOptional
Filters for objects created after the provided timestamp (inclusive).
modified_date.beforedatetimeOptional
Filters for objects created before the provided timestamp (inclusive).
owned_bystringOptional
Filters for accounts owned by the specified user(s).
sort_bystringOptional
Fields to sort the accounts by and the direction to sort them in.
stagestringOptional
Filters for accounts on specified stages.
tagsstringOptional
List of tags to be filtered.

Response

This endpoint returns an object
accounts
list of objects
The exported accounts.
GET
1curl -G https://api.devrev.ai/accounts.export \
2 -H "Authorization: <apiKey>" \
3 --data-urlencode created_date.after=2023-01-01T12:00:00Z \
4 --data-urlencode created_date.before=2023-01-01T12:00:00Z \
5 --data-urlencode modified_date.after=2023-01-01T12:00:00Z \
6 --data-urlencode modified_date.before=2023-01-01T12:00:00Z
200
Retrieved
1{
2 "accounts": [
3 {
4 "external_refs": [
5 "external_refs"
6 ],
7 "id": "id",
8 "owned_by": [],
9 "artifacts": [
10 {
11 "id": "id"
12 }
13 ],
14 "created_date": "2023-01-01T12:00:00Z",
15 "custom_schema_fragments": [
16 "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
17 ],
18 "description": "description",
19 "display_id": "display_id",
20 "display_name": "display_name",
21 "domains": [
22 "domains"
23 ],
24 "modified_date": "2023-01-01T12:00:00Z",
25 "stock_schema_fragment": "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>",
26 "subtype": "subtype",
27 "tags": [
28 {
29 "tag": {
30 "id": "id",
31 "name": "name"
32 }
33 }
34 ],
35 "tier": "tier"
36 }
37 ]
38}