CrmCompany

Search Companies

POST

Search for 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

Request

This endpoint expects an object.

searchCriteria

anyRequired

Response

This endpoint returns an object

status

enum

Allowed values: okerror

results

list of objects

stringOptional

POST

1 curl -X POST "https://api.revert.dev/crm/companies/search?fields=string&pageSize=string" \
2      -H "x-revert-api-token: string" \
3      -H "x-revert-t-id: string" \
4      -H "x-api-version: string" \
5      -H "Content-Type: application/json" \
6      -d '{
7   "searchCriteria": {}
8 }'

200Successful

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 }

Built with

1	curl -X POST "https://api.revert.dev/crm/companies/search?fields=string&pageSize=string" \
2	-H "x-revert-api-token: string" \
3	-H "x-revert-t-id: string" \
4	-H "x-api-version: string" \
5	-H "Content-Type: application/json" \
6	-d '{
7	"searchCriteria": {}
8	}'

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	}