Companies

Add contacts to a company

Add up to 100 contacts (`contact_ids`) to a company: each one without a current role there gets one (no title), and the others are skipped. Never ends other roles. Any contact outside the workspace is

POST /v2/companies/{companyId}/add-contacts

Parameters

Path parameters

companyId

string (uuid) required

Request body

Content-Type: application/json

contact_ids

array<string (uuid)> required

Example

{
  "contact_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

Responses

200 — Successful response

Content-Type: application/json

data

object required

data.added

array<string (uuid)> required

data.skipped

array<string (uuid)> required

data.contacts

array<object> required

data.contacts[].id

string (uuid) required

data.contacts[].company

string | null required

Example

{
  "data": {
    "added": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "skipped": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "contacts": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "company": "string"
      }
    ]
  }
}

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/00000000-0000-0000-0000-000000000000/add-contacts \
  --request POST \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "contact_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}'

fetch('https://api.prod.getdex.com/v2/companies/00000000-0000-0000-0000-000000000000/add-contacts', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    contact_ids: ['00000000-0000-0000-0000-000000000000']
  })
})

requests.post(
    "https://api.prod.getdex.com/v2/companies/00000000-0000-0000-0000-000000000000/add-contacts",
    headers={
      "Authorization": "Bearer YOUR_API_KEY",
      "Content-Type": "application/json"
    },
    json={
      "contact_ids": [
        "00000000-0000-0000-0000-000000000000"
      ]
    }
)

List companies

List the workspace's companies by name, then id. `archived` false (default) lists active companies, true archived ones only. `assignee_id` filters on the company's owner: a user id (active or not), `m

Archive a company

Archive a company: it leaves the default list and stays readable by ID. Archiving an archived company changes nothing. The optional body `{ archive_contacts: true }` also archives every active contact