List Accounts (POST)

POST

Gets a list of accounts.

Request

This endpoint expects an object.

created_bylist of stringsOptional

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

created_dateobjectOptional

cursorstringOptionalformat: "text"

The cursor to resume iteration from. If not provided, then iteration starts from the beginning.

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.

limitintegerOptional

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

modeenumOptional

Allowed values: afterbefore

The iteration mode to use. If “after”, then entries after the provided cursor will be returned, or if no cursor is provided, then from the beginning. If “before”, then entries before the provided cursor will be returned, or if no cursor is provided, then from the end. Entries will always be returned in the specified sort-by order.

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.

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 listing all accounts matching the filter criteria.

accountslist of objects

List containing all the accounts

next_cursorstringOptionalformat: "text"

The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.

prev_cursorstringOptionalformat: "text"

The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.

Errors

POST

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

200accountsListPostExample

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

Merge Accounts

Up Next

Built with

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

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