Companies

Create companies in bulk

Create up to 100 companies, all or nothing: one invalid company or website conflict (with an existing company or another in the batch) creates none. A website conflict is 409 with `details.existing_co

POST /v2/companies/batch

Parameters

Header parameters

Idempotency-Key

string required

Required. UUID per logical operation, reused on every retry. See apps/rest-api/src/shared/idempotency.ts for the full contract. Missing → 400 BadRequest; same key + different body → 409 Conflict.

Request body

Content-Type: application/json

companies

array<object> required

companies[].name

string required

companies[].description

string

companies[].linkedin_description

string

companies[].website_url

string

companies[].linkedin_slug

string

companies[].facebook_slug

string

companies[].x_slug

string

companies[].instagram_slug

string

companies[].headquarters_location

string

companies[].country_code

string

companies[].email

string

companies[].phone_number

string

companies[].arr_estimate

integer

companies[].number_of_employees

integer

companies[].assignee_id

object enum

Possible values: null

Example

{
  "companies": [
    {
      "name": "string"
    }
  ]
}

Responses

201 — Created

Content-Type: application/json

data

object required

data.companies

array<object> required

data.companies[].id

string (uuid) required

data.companies[].user_id

string required

data.companies[].workspace_id

string (uuid) | null required

data.companies[].assignee_id

string | null required

data.companies[].name

string required

data.companies[].description

string | null required

data.companies[].linkedin_description

string | null required

data.companies[].logo_url

string | null required

data.companies[].website_url

string | null required

data.companies[].linkedin_slug

string | null required

data.companies[].facebook_slug

string | null required

data.companies[].x_slug

string | null required

data.companies[].instagram_slug

string | null required

data.companies[].headquarters_location

string | null required

data.companies[].country_code

string | null required

data.companies[].email

string | null required

data.companies[].phone_number

string | null required

data.companies[].arr_estimate

integer | null required

data.companies[].number_of_employees

integer | null required

data.companies[].linkedin_data

object | null required

data.companies[].linkedin_data.industry

string

data.companies[].linkedin_data.company_type

string

data.companies[].linkedin_data.size_range

string

data.companies[].linkedin_data.specialities

array<string>

data.companies[].ignore_merge

boolean required

data.companies[].archived_at

string (date-time) required

data.companies[].created_at

string (date-time) required

data.companies[].updated_at

string (date-time) required

data.companies[].companies_custom_fields

array<object> required

data.companies[].companies_custom_fields[].custom_field_id

string (uuid) required

data.companies[].companies_custom_fields[].text_value

string | null required

data.companies[].companies_custom_fields[].array_value

array<string> required

data.companies[].companies_custom_fields[].date_value

string (date-time) required

data.companies[].companies_custom_fields[].member_user_id

string | null required

data.companies[].companies_custom_fields[].number_value

number | null required

data.companies[].companies_custom_fields[].boolean_value

boolean | null required

data.companies[].companies_custom_fields_contacts

array<object> required

data.companies[].companies_custom_fields_contacts[].custom_field_id

string (uuid) required

data.companies[].companies_custom_fields_contacts[].linked_contact_id

string (uuid) required

data.companies[].companies_custom_fields_companies

array<object> required

data.companies[].companies_custom_fields_companies[].custom_field_id

string (uuid) required

data.companies[].companies_custom_fields_companies[].linked_company_id

string (uuid) required

data.companies[].tag_ids

array<string (uuid)> required

data.pagination

object

data.pagination.nextCursor

string | null

data.pagination.count

integer

Example

{
  "data": {
    "companies": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "user_id": "string",
        "workspace_id": "00000000-0000-0000-0000-000000000000",
        "assignee_id": "string",
        "name": "string",
        "description": "string",
        "linkedin_description": "string",
        "logo_url": "string",
        "website_url": "string",
        "linkedin_slug": "string",
        "facebook_slug": "string",
        "x_slug": "string",
        "instagram_slug": "string",
        "headquarters_location": "string",
        "country_code": "string",
        "email": "string",
        "phone_number": "string",
        "arr_estimate": 0,
        "number_of_employees": 0,
        "linkedin_data": {
          "industry": "string",
          "company_type": "string"
        },
        "ignore_merge": false,
        "archived_at": "2026-10-23T10:31:51.481Z",
        "created_at": "2026-10-23T10:31:51.481Z",
        "updated_at": "2026-10-23T10:31:51.481Z",
        "companies_custom_fields": [
          {
            "custom_field_id": "00000000-0000-0000-0000-000000000000",
            "text_value": "string",
            "array_value": [
              null
            ],
            "date_value": "2026-10-23T10:31:51.481Z",
            "member_user_id": "string",
            "number_value": 0,
            "boolean_value": false
          }
        ],
        "companies_custom_fields_contacts": [
          {
            "custom_field_id": "00000000-0000-0000-0000-000000000000",
            "linked_contact_id": "00000000-0000-0000-0000-000000000000"
          }
        ],
        "companies_custom_fields_companies": [
          {
            "custom_field_id": "00000000-0000-0000-0000-000000000000",
            "linked_company_id": "00000000-0000-0000-0000-000000000000"
          }
        ],
        "tag_ids": [
          "00000000-0000-0000-0000-000000000000"
        ]
      }
    ]
  }
}

400 — Request body failed validation.

Content-Type: application/json

(body)

any

401 — Missing or invalid API key.

Content-Type: application/json

(body)

any

403 — Valid key, insufficient permission.

Content-Type: application/json

(body)

any

404 — Resource does not exist.

Content-Type: application/json

(body)

any

409 — Request conflicts with the current state of the resource.

Content-Type: application/json

(body)

any

429 — Rate limit exceeded.

Content-Type: application/json

(body)

any

500 — Unexpected server error.

Content-Type: application/json

(body)

any

Code samples

curl https://api.prod.getdex.com/v2/companies/batch \
  --request POST \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "companies": [
    {
      "name": "string"
    }
  ]
}'

fetch('https://api.prod.getdex.com/v2/companies/batch', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    companies: [
      {
        name: 'string'
      }
    ]
  })
})

requests.post(
    "https://api.prod.getdex.com/v2/companies/batch",
    headers={
      "Authorization": "Bearer YOUR_API_KEY",
      "Content-Type": "application/json"
    },
    json={
      "companies": [
        {
          "name": "string"
        }
      ]
    }
)

Count a company's contacts

Count the company's active contacts per section: `current` (at least one current role there) and `past` (only past or unknown roles there). Archived contacts are not counted. 404 `record_not_found` wh

List a contact's company roles

List the roles of one workspace contact (`contact_id`) at companies, archived companies included. 404 `record_not_found` when the contact is not in the workspace. Workspace-only: send the `X-Dex-Works