Karia
Guides

Organisation

Discover organisations and workspaces before calling workspace-scoped endpoints

Organisation Guide

Use the organisation endpoints to discover the organisation and workspace identifiers required by most of the rest of the API.

Primary Workflow

  1. List organisations with GET /organisation.
  2. For a selected organisation, list workspaces with GET /organisation/{orgId}/workspace.
  3. Reuse the resulting orgId and workspaceId in downstream endpoint families such as contacts, employers, invoices, and sales (origination).

Reference

Covered Operations

  • GET /organisation
  • GET /organisation/{orgId}/workspace

On this page