Companies
Get field values on a single Company
| ⚠️ This endpoint is currently in BETA |
|---|
Paginate through field values on a single company.
Enriched, global, and relationship-intelligence fields will be included by default. The ids and types parameters can be used to filter the collection. These parameters are mutually exclusive.
List fields are not returned by this endpoint. To retrieve or update list field values, use the list entry fields endpoints.
get/v2/companies/{companyId}/fields
Path parameters
companyIdinteger required
Company ID
Query parameters
idsstring[]
Field IDs for which to return field data
[ "field-1" ]
typesstring[]
Field Types for which to return field data
cursorstring
Example:ICAgICAgYmVmb3JlOjo6Nw
Cursor for the next or previous page
limitinteger
Example:20
Number of items to include in the page
Response
OK
Example response
{
"data": [
{
"id": "affinity-data-location",
"name": "Location",
"type": "enriched",
"enrichmentSource": "affinity-data",
"value": {
"type": "company-multi",
"data": [
{
"id": 1,
"name": "Horizon Technologies",
"domain": "horizontech.com"
},
{
"id": 2,
"name": "Crestwood Capital",
"domain": "crestwoodcap.com"
}
]
}
}
],
"pagination": {
"prevUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgYmVmb3JlOjo6Nw",
"nextUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgIGFmdGVyOjo6NA"
}
}