List companies

GEThttps://api.norreach.app/v1/companies

The companies your contacts work at, with how many contacts each — derived from the contacts' company field (there are no separate company records): spellings that differ only in case or spacing are one company, named the way most contacts name it. Most contacts first. q narrows to companies whose name contains it. Counts cover the newest 20 000 contacts with a company (counts_capped says when there are more).

contacts:readOperation id: list_companies

GET/companies

curl -X GET "https://api.norreach.app/v1/companies" \
  -H "Authorization: Bearer $NORREACH_API_KEY"

List companies

{
  "object": "list",
  "data": [
    {
      "object": "company",
      "name": "Karolinska Care",
      "contacts": 14
    },
    {
      "object": "company",
      "name": "Nordic Dental",
      "contacts": 6
    }
  ],
  "has_more": false,
  "next_cursor": null,
  "counts_capped": false
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication: send Authorization: Bearer <key>, with an API key or an OAuth access token. The key needs the scope contacts:read. API keys and scopes

Query parameters

limitintegerquery

Page size (1–200, default 50).

cursorstringquery

The next_cursor of the previous page.

qstringquery

Part of the company's name.

Response

200application/json— List companies

object"list"required

dataobject[]required

Show child attributes

data[].object"company"required

data[].namestringrequired

The company as your contacts name it.

data[].contactsintegerrequired

Contacts at this company.

has_morebooleanrequired

next_cursorstring | nullrequired

counts_cappedbooleanrequired

Errors

Errors are application/problem+json with a stable code.

Status	Code	Meaning
400	`bad_request`	The request couldn't be read.
400	`unknown_field`	The request has a field this operation doesn't know.
400	`invalid_cursor`	That cursor doesn't belong to this list.
401	`unauthorized`	A valid API key is required.
403	`insufficient_scope`	This API key doesn't have the scope this operation needs.
403	`feature_not_enabled`	The API isn't switched on for this workspace.
429	`rate_limited`	Too many requests. Slow down and try again.
500	`server_error`	Something went wrong on our side.
503	`unavailable`	The API isn't available right now. Try again shortly.

GET/companies

curl -X GET "https://api.norreach.app/v1/companies" \
  -H "Authorization: Bearer $NORREACH_API_KEY"

List companies

{
  "object": "list",
  "data": [
    {
      "object": "company",
      "name": "Karolinska Care",
      "contacts": 14
    },
    {
      "object": "company",
      "name": "Nordic Dental",
      "contacts": 6
    }
  ],
  "has_more": false,
  "next_cursor": null,
  "counts_capped": false
}