Organizations

Organizations are the top-level entry point for the HyperRep v2 API. Start here to find the organizations available to your API key and get the organization_id value used by the rest of the reference surface.

List organizations

GET /api/v2/organizations

Key response fields:

  • Name
    organization_id
    Description

    The organization identifier used in the path for contacts, companies, agents, conversations, analytics, and sales requests.

  • Name
    name
    Description

    The display name of the organization.

Use the returned organization_id in the pages that follow, for example:

List organizations

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

Example response

{
  "data": [
    {
      "organization_id": "gAAAAABexampleOrganizationIdReturnedByApi7mN4qP2xLs9dV5kTr8cY1hJ6uW3",
      "name": "Acme Roofing"
    }
  ]
}

Was this page helpful?