Skip to main content
API Preview
Developers

REST API/Organisations

Organisations

Organisation profiles, context configuration, and collective administration.

7 endpoints

Endpoints

MethodPathAuth
GET/orgs/{org_id}/sso/configuration

Get SSO configuration

JWT
POST/orgs/{org_id}/sso/configure

Configure SSO

JWT
GET/orgs/me

Get current organisation profile

JWT
PATCH/orgs/me

Update organisation profile

JWT
GET/orgs/me/culture-profile

Get culture profile

JWT
GET/orgs/me/culture-profile/questionnaire

Get culture questionnaire

JWT
GET/orgs/me/matches

Get organisation matches

JWT

Endpoint Details

GET /orgs/me

GET/orgs/meJWT

Returns the authenticated organisation profile.

Response

json
{
  "id": "e1f2a3b4-c5d6-7890-efab-cdef12345678",
  "name": "TechCorp AU",
  "industry": "Technology",
  "size": "mid_market",
  "tier": "partner",
  "headquarters_country": "AU",
  "website": "https://techcorp.example.com",
  "created_at": "2026-02-15T10:00:00Z"
}

PATCH /orgs/me

PATCH/orgs/meJWT

Update organisation profile fields. Requires org_admin role.

GET /orgs/me/culture-profile

GET/orgs/me/culture-profileJWT

Returns the organisation culture profile including BRAVING dimensions and CVF quadrant scores.

Query Parameters

NameTypeDescription
versionintegerSpecific version, or latest if omitted

GET /orgs/me/culture-profile/questionnaire

GET/orgs/me/culture-profile/questionnaireJWT

Returns the culture profile questionnaire structure with BRAVING dimensions and CVF quadrant questions.

GET /orgs/me/matches

GET/orgs/me/matchesJWT

List all matches across the organisation's contexts. Cursor-paginated with quality and status filters.

Query Parameters

NameTypeDescription
job_idstringFilter by job UUID
qualitystringFilter by match quality tier
statusstringFilter by match status
limitintegerPage size (max 100)
cursorstringPagination cursor

POST /orgs/{org_id}/sso/configure

POST/orgs/{org_id}/sso/configureJWT

Configure SAML SSO for the organisation. Requires E3 Operator tier or above.

Path Parameters

NameTypeDescription
org_id*stringOrg UUID

GET /orgs/{org_id}/sso/configuration

GET/orgs/{org_id}/sso/configurationJWT

Retrieve the current SSO configuration. Requires E3 Operator tier.

Path Parameters

NameTypeDescription
org_id*stringOrg UUID