Companies

Create a company

Create a company in the workspace. `name` is required (1-150 characters, trimmed); names need not be unique. `website_url` is stored as typed, with `https://` added when no scheme is given; another co

POST /v2/companies/

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

company

object required

company.name

string required

company.description

string

company.linkedin_description

string

company.website_url

string

company.linkedin_slug

string

company.facebook_slug

string

company.x_slug

string

company.instagram_slug

string

company.headquarters_location

string

company.country_code

string

company.email

string

company.phone_number

string

company.arr_estimate

integer

company.number_of_employees

integer

company.assignee_id

object enum

Possible values: null

Example

{
  "company": {
    "name": "string"
  }
}

Responses

201 — Created

Content-Type: application/json

data

object required

data.company

object required

data.company.id

string (uuid) required

data.company.user_id

string required

data.company.workspace_id

string (uuid) | null required

data.company.assignee_id

string | null required

data.company.name

string required

data.company.description

string | null required

data.company.linkedin_description

string | null required

data.company.logo_url

string | null required

data.company.website_url

string | null required

data.company.linkedin_slug

string | null required

data.company.facebook_slug

string | null required

data.company.x_slug

string | null required

data.company.instagram_slug

string | null required

data.company.headquarters_location

string | null required

data.company.country_code

string | null required

data.company.email

string | null required

data.company.phone_number

string | null required

data.company.arr_estimate

integer | null required

data.company.number_of_employees

integer | null required

data.company.linkedin_data

object | null required

data.company.linkedin_data.industry

string

data.company.linkedin_data.company_type

string

data.company.linkedin_data.size_range

string

data.company.linkedin_data.specialities

array<string>

data.company.ignore_merge

boolean required

data.company.archived_at

string (date-time) required

data.company.created_at

string (date-time) required

data.company.updated_at

string (date-time) required

data.company.companies_custom_fields

array<object> required

data.company.companies_custom_fields[].custom_field_id

string (uuid) required

data.company.companies_custom_fields[].text_value

string | null required

data.company.companies_custom_fields[].array_value

array<string> required

data.company.companies_custom_fields[].date_value

string (date-time) required

data.company.companies_custom_fields[].member_user_id

string | null required

data.company.companies_custom_fields[].number_value

number | null required

data.company.companies_custom_fields[].boolean_value

boolean | null required

data.company.companies_custom_fields_contacts

array<object> required

data.company.companies_custom_fields_contacts[].custom_field_id

string (uuid) required

data.company.companies_custom_fields_contacts[].linked_contact_id

string (uuid) required

data.company.companies_custom_fields_companies

array<object> required

data.company.companies_custom_fields_companies[].custom_field_id

string (uuid) required

data.company.companies_custom_fields_companies[].linked_company_id

string (uuid) required

data.company.tag_ids

array<string (uuid)> required

Example

{
  "data": {
    "company": {
      "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.477Z",
      "created_at": "2026-10-23T10:31:51.477Z",
      "updated_at": "2026-10-23T10:31:51.477Z",
      "companies_custom_fields": [
        {
          "custom_field_id": "00000000-0000-0000-0000-000000000000",
          "text_value": "string",
          "array_value": [
            "string"
          ],
          "date_value": "2026-10-23T10:31:51.477Z",
          "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/ \
  --request POST \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "company": {
    "name": "string"
  }
}'

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

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

Create and add tags to a company

Find or create workspace tags by name (`tagNames`, up to 50) and add them to one company, archived or not. 404 `record_not_found` when the company is not in the workspace; 409 `write_conflict` when a

Search companies

Typeahead over the workspace's active companies: matches `query` (required, trimmed, 1-100 characters; 400 when blank) accent-insensitively against the name, the website's domain (scheme, `www.` and p