CrmCompany

Get Companies

GET
Get all the companies

Headers

x-revert-api-tokenstringRequired
Your official API key for accessing revert apis.
x-revert-t-idstringRequired
The unique customer id used when the customer linked their account.
x-api-versionstringOptional
Optional Revert API version you're using. If missing we default to the latest version of the API.

Query parameters

fieldsstringOptional
pageSizestringOptional
cursorstringOptional

Response

This endpoint returns an object
status
enum
Allowed values: okerror
results
list of objects
next
stringOptional
previous
stringOptional
GET
$curl -G https://api.revert.dev/crm/companies \
> -H "x-revert-api-token: string" \
> -H "x-revert-t-id: string" \
> -H "x-api-version: string" \
> -d fields=string \
> -d pageSize=string
Response
1{
2 "status": "ok",
3 "results": [
4 {
5 "address": {
6 "city": "string",
7 "state": "string",
8 "country": "string",
9 "zip": "string",
10 "postalCode": "string",
11 "street": "string"
12 },
13 "annualRevenue": 0,
14 "createdTimestamp": {},
15 "description": "string",
16 "id": "string",
17 "industry": "string",
18 "name": "string",
19 "phone": "string",
20 "remoteId": "string",
21 "size": 0,
22 "updatedTimestamp": {},
23 "additional": {}
24 }
25 ],
26 "next": "string",
27 "previous": "string"
28}