CustomerBASE API

Get organization details

Retrieves detailed organization information by ID or COS ID

get/customerbase/v1/organizations/{id}

Request

Base URL
https://api.customeros.ai
Auth
API key in header X-CUSTOMER-OS-API-KEY
TypeScript
https://skmtc.dev/customeros/apis/customeros-api/docs/customerbase/v1/organizations/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

idstring required

Organization ID or COS ID

Organization found

requestIdstring

statusstring

Status indicates the result of the operation ("success" or "error")

{
  "requestId": "1234567890abcdef",
  "status": "success"
}

Jul 17, 202673526747b270 Revision changes
- info
  added the success response with the status
Oct 16, 20243087b1c760de Revision changes
- info
  endpoint added