Skip to main content
GET
/
v2
/
companies
/
{companyId}
Get a single Company
curl --request GET \
  --url https://api.affinity.co/v2/companies/{companyId} \
  --header 'Authorization: Bearer <token>'
{
  "id": 4503599627370496,
  "name": "<string>",
  "domain": "<string>",
  "domains": [
    "<string>"
  ],
  "isGlobal": true,
  "fields": [
    {
      "id": "<string>",
      "name": "<string>",
      "type": "enriched",
      "enrichmentSource": "affinity-data",
      "value": {
        "data": {
          "continent": "North America",
          "country": "United States",
          "streetAddress": "1 Main Street",
          "city": "San Francisco",
          "state": "California"
        },
        "type": "location"
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
companyId
integer<int64>
required

Company ID

Required range: 1 <= x <= 9007199254740991

Query Parameters

​
fieldIds
string[]

Field IDs for which to return field data

Example:
["field-1"]
​
fieldTypes
enum<string>[]

Field Types for which to return field data

Available options:
enriched,
global,
relationship-intelligence

Response

OK

Company model

​
id
integer<int64>
required

The company's unique identifier

Required range: 1 <= x <= 9007199254740991
Example:

1

​
name
string
required

The company's name

Example:

"Acme"

​
domain
string<hostname> | null
required

The company's primary domain

Example:

"acme.co"

​
domains
string<hostname>[]
required

All of the company's domains

Example:
["acme.co"]
​
isGlobal
boolean
required

Whether or not the company is tenant specific

Example:

true

​
fields
Field · object[]

The fields associated with the company