Companies

Get field values on a single Company

Changed on
⚠️ 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

Request

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

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"
  }
}

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