Companies

Use the companies endpoints to read the companies attached to an organization. Companies are groups of your customers associated with an organization.

List companies

GET /api/v2/organizations/{organization_id}/companies

This endpoint supports limit and cursor.

Key response fields:

Name
company_id
Description
The company identifier used for the company detail endpoint.
Name
name
Description
The company name.
Name
custom_fields
Description
Custom company field values keyed by field name.
Name
domain
Description
The company website or domain when available.
Name
address
Description
The company address when available.
Name
agent_id
Description
The assigned agent identifier when the company is linked to an agent.
Name
created_at
Description
When the company was created.

List companies

curl -G https://api.hyperrep.ai/api/v2/organizations/HR_id_example_organization_id/companies \
  -H "X-API-KEY: your-api-key" \
  --data-urlencode "limit=25"

Example response

{
  "data": [
    {
      "company_id": "HR_id_example_company_id",
      "name": "HyperRep Consumer Group",
      "domain": "hyperrep.com",
      "custom_fields": {
        "notes": "Priority account"
      },
      "address": "123 Main St, Anytown USA",
      "agent_id": "HR_id_example_agent_id",
      "created_at": "2026-03-10T12:00:00Z"
    }
  ],
  "pagination": {
    "limit": 25,
    "cursor": null,
    "next_cursor": null,
    "has_more": false
  }
}

Create a company

POST /api/v2/organizations/{organization_id}/companies

Use this endpoint to create one company under an organization. name is required. agent_id is optional, but when provided it must belong to the same organization.

Domain handling: lowercased, protocol removed, path removed, and must include a dot (.). Example accepted input: ferrisaircraft.com.

Request body fields:

Name
name
Description
Required company name.
Name
domain
Description
Optional company domain. Example format: ferrisaircraft.com.
Name
address
Description
Optional company address.
Name
custom_fields
Description
Optional custom company field values keyed by field name.
Name
agent_id
Description
Optional agent identifier.

Create one company

curl -X POST https://api.hyperrep.ai/api/v2/organizations/HR_id_example_organization_id/companies \
  -H "X-API-KEY: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Ferris Aircraft",
    "domain": "ferrisaircraft.com",
    "address": "100 Coastline Ave, Coast City, CA",
    "custom_fields": {
      "notes": "Enterprise account"
    },
    "agent_id": "HR_id_example_agent_id"
  }'

Example response

{
  "company_id": "HR_id_example_company_id",
  "name": "Ferris Aircraft",
  "domain": "ferrisaircraft.com",
  "custom_fields": {
    "notes": "Enterprise account"
  },
  "address": "100 Coastline Ave, Coast City, CA",
  "agent_id": "HR_id_example_agent_id",
  "created_at": "2026-05-15T16:45:12.000000Z"
}

Get a company

GET /api/v2/organizations/{organization_id}/companies/{company_id}

Use the company_id returned by the list endpoint.

This endpoint returns one company in the same canonical company shape used by the list endpoint.

Get one company

curl https://api.hyperrep.ai/api/v2/organizations/HR_id_example_organization_id/companies/HR_id_example_company_id \
  -H "X-API-KEY: your-api-key"

Example response

{
    "company_id": "HR_id_example_company_id",
    "name": "HyperRep Consumer Group",
    "domain": "hyperrep.com",
    "custom_fields": {
      "notes": "Priority account"
    },
    "address": "123 Main St, Anytown USA",
    "agent_id": "HR_id_example_agent_id",
    "created_at": "2026-03-10T12:00:00Z"
  }