Get all Companies
Paginate through Companies in Affinity. Returns basic information and non-list-specific field data on each Company.
To retrieve field data, you must use either the fieldIds or the fieldTypes parameter to specify the Fields for which you want data returned. These Field IDs and Types can be found using the GET /v2/companies/fields endpoint. When no fieldIds or fieldTypes are provided, Companies will be returned without any field data attached. To supply multiple fieldIds or fieldTypes parameters, generate a query string that looks like this: ?fieldIds=field-1234&fieldIds=affinity-data-location or ?fieldTypes=enriched&fieldTypes=global.
Requires the "Export All Organizations directory" permission.
Query parameters
Cursor for the next or previous page
Number of items to include in the page
Company IDs
Field IDs for which to return field data
[ "field-1" ]
Field Types for which to return field data
Response
OK
Example response
{
"data": [
{
"id": 1,
"name": "Horizon Technologies",
"domain": "horizontech.com",
"domains": [
"horizontech.com"
],
"isGlobal": false,
"fields": []
},
{
"id": 2,
"name": "Crestwood Capital",
"domain": "crestwoodcap.com",
"domains": [
"crestwoodcap.com"
],
"isGlobal": false,
"fields": []
}
],
"pagination": {
"prevUrl": "https://api.affinity.co/v2/companies?cursor=ICAgICAgYmVmb3JlOjo6Nw",
"nextUrl": "https://api.affinity.co/v2/companies?cursor=ICAgICAgIGFmdGVyOjo6NA"
}
}