Companies

Get a single Company

Changed on

Returns basic information and non-list-specific field data on the requested 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.

get/v2/companies/{companyId}

Request

  • Base URL
    https://api.affinity.co
  • URL
    https://api.affinity.co/v2/companies/{companyId}
  • Auth
    HTTP bearer

Path parameters

companyIdinteger required

Company ID

Query parameters

fieldIdsstring[]

Field IDs for which to return field data

[
  "field-1"
]
fieldTypesstring[]

Field Types for which to return field data

Response

OK

idinteger required

The company's unique identifier

namestring required

The company's name

domainstring hostname nullable required

The company's primary domain

domainsstring[] required

All of the company's domains

isGlobalboolean required

Whether or not the company is tenant specific

Example response

{
  "id": 1,
  "name": "Horizon Technologies",
  "domain": "horizontech.com",
  "domains": [
    "horizontech.com"
  ],
  "isGlobal": true,
  "fields": [
    {
      "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"
          }
        ]
      }
    }
  ]
}

Changes

    • info

      added authentication authorization bad-request conflict method-not-allowed not-acceptable not-found not-implemented rate-limit server timeout unprocessable-entity unsupported-media-type validation discriminator mapping keys to the / response property for the response status

    • info

      added bad-request validation discriminator mapping keys to the / response property for the response status

    • info

      added chat-message email meeting call discriminator mapping keys to the ///// response property for the response status

    • info

      added company company-multi datetime dropdown dropdown-multi number number-multi filterable-text filterable-text-multi formula-number interaction location location-multi person person-multi ranked-dropdown text discriminator mapping keys to the // response property for the response status

    • info

      removed the hidden enum value from the // response property for the response status