Get metadata on Company Fields

curl --request GET \
  --url https://api.affinity.co/v2/companies/fields \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "affinity-data-industry",
      "name": "Industry",
      "type": "enriched",
      "valueType": "filterable-text-multi",
      "enrichmentSource": "affinity-data",
      "createdAt": "2024-03-07T20:21:42Z"
    },
    {
      "id": "affinity-data-last-funding-amount",
      "name": "Last Funding Amount (USD)",
      "type": "enriched",
      "valueType": "number",
      "enrichmentSource": "affinity-data",
      "createdAt": "2024-03-07T20:21:42Z"
    },
    {
      "id": "affinity-data-last-funding-date",
      "name": "Last Funding Date",
      "type": "enriched",
      "valueType": "datetime",
      "enrichmentSource": "affinity-data",
      "createdAt": "2024-03-07T20:21:42Z"
    },
    {
      "id": "affinity-data-location",
      "name": "Location",
      "type": "enriched",
      "valueType": "location",
      "enrichmentSource": "affinity-data",
      "createdAt": "2024-03-07T20:21:42Z"
    },
    {
      "id": "field-1",
      "name": "Custom global field",
      "type": "global",
      "valueType": "text",
      "enrichmentSource": null,
      "createdAt": "2024-03-07T20:21:42Z"
    },
    {
      "id": "last-email",
      "name": "Last Email",
      "type": "relationship-intelligence",
      "valueType": "interaction",
      "enrichmentSource": null,
      "createdAt": null
    },
    {
      "id": "persons",
      "name": "People",
      "type": "enriched",
      "valueType": "person-multi",
      "enrichmentSource": null,
      "createdAt": null
    }
  ],
  "pagination": {
    "prevUrl": null,
    "nextUrl": "https://api.affinity.co/v2/companies/fields?cursor=ICAgICAgIGFmdGVyOjo6NA"
  }
}

Companies

Get metadata on Company Fields

Returns metadata on non-list-specific Company Fields.

Use the returned Field IDs to request field data from the GET /v2/companies and GET /v2/companies/{id} endpoints.

You can filter Fields using the filter query parameter. The filter parameter is a string that you can specify conditions based on the following properties.

Property Name	Type	Allowed Operators	Examples
`name`	`text`	`=`, `=~`	`name="Location"`, `name=~loc`

Use the includes query parameter to add optional metadata to each Field in the response. Pass includes more than once to request multiple values.

Value	Adds to each Field
`filterability`	How the field can be used in filter expressions on GET `/v2/companies` and POST `/v2/companies/search`
`sortability`	How the field can be used in sort expressions on those endpoints

Example: GET /v2/companies/fields?includes=filterability&includes=sortability

GET

companies

fields

Get metadata on Company Fields

curl --request GET \
  --url https://api.affinity.co/v2/companies/fields \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "affinity-data-industry",
      "name": "Industry",
      "type": "enriched",
      "valueType": "filterable-text-multi",
      "enrichmentSource": "affinity-data",
      "createdAt": "2024-03-07T20:21:42Z"
    },
    {
      "id": "affinity-data-last-funding-amount",
      "name": "Last Funding Amount (USD)",
      "type": "enriched",
      "valueType": "number",
      "enrichmentSource": "affinity-data",
      "createdAt": "2024-03-07T20:21:42Z"
    },
    {
      "id": "affinity-data-last-funding-date",
      "name": "Last Funding Date",
      "type": "enriched",
      "valueType": "datetime",
      "enrichmentSource": "affinity-data",
      "createdAt": "2024-03-07T20:21:42Z"
    },
    {
      "id": "affinity-data-location",
      "name": "Location",
      "type": "enriched",
      "valueType": "location",
      "enrichmentSource": "affinity-data",
      "createdAt": "2024-03-07T20:21:42Z"
    },
    {
      "id": "field-1",
      "name": "Custom global field",
      "type": "global",
      "valueType": "text",
      "enrichmentSource": null,
      "createdAt": "2024-03-07T20:21:42Z"
    },
    {
      "id": "last-email",
      "name": "Last Email",
      "type": "relationship-intelligence",
      "valueType": "interaction",
      "enrichmentSource": null,
      "createdAt": null
    },
    {
      "id": "persons",
      "name": "People",
      "type": "enriched",
      "valueType": "person-multi",
      "enrichmentSource": null,
      "createdAt": null
    }
  ],
  "pagination": {
    "prevUrl": null,
    "nextUrl": "https://api.affinity.co/v2/companies/fields?cursor=ICAgICAgIGFmdGVyOjo6NA"
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

cursor

string

Cursor for the next or previous page

Example:

"ICAgICAgYmVmb3JlOjo6Nw"

limit

integer<int32>

default:100

Number of items to include in the page

Required range: 1 <= x <= 100

Example:

100

filter

string

Filter options

includes

enum<string>[]

Additional properties to include in the response

Available options:

filterability,

sortability

Response

FieldMetadataPaged model

data

FieldMetadata · object[]

required

A page of FieldMetadata results

Maximum array length: 100

Show child attributes

pagination

Pagination · object

required

Show child attributes

Get all Companies Get dropdown options for a Company Field

⌘I