Organization Onboarding

Create an organization onboarding shell

POST/organization-onboardings

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://example.com/organization-onboardings" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "slug": "string",    "timezone": "string",    "departments": [      "growth"    ]  }'

{  "success": true,  "statusCode": 201,  "message": "Organization onboarding created.",  "data": {},  "meta": {    "timestamp": "2026-07-14T08:00:00.000Z"  }}

{  "success": false,  "statusCode": 400,  "message": "Validation failed.",  "error": {    "code": "request_failed"  },  "meta": {    "timestamp": "2026-07-14T08:00:00.000Z"  }}

{  "success": false,  "statusCode": 409,  "message": "An organization with this slug already exists.",  "error": {    "code": "request_failed"  },  "meta": {    "timestamp": "2026-07-14T08:00:00.000Z"  }}

Get the current organization onboarding state

GET/organizations/{organizationId}/onboarding

Path Parameters

organizationId*string

Organization identifier.

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/onboarding"

{  "success": true,  "statusCode": 200,  "message": "Organization onboarding found.",  "data": {},  "meta": {    "timestamp": "2026-07-14T08:00:00.000Z"  }}

{  "success": false,  "statusCode": 404,  "message": "Organization not found.",  "error": {    "code": "request_failed"  },  "meta": {    "timestamp": "2026-07-14T08:00:00.000Z"  }}

Discard incomplete organization onboarding

DELETE/organizations/{organizationId}/onboarding

Path Parameters

organizationId*string

Organization identifier.

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/onboarding"

{  "success": true,  "statusCode": 200,  "message": "Organization onboarding discarded.",  "data": {},  "meta": {    "timestamp": "2026-07-14T08:00:00.000Z"  }}

{  "success": false,  "statusCode": 409,  "message": "Onboarding state does not permit this action.",  "error": {    "code": "request_failed"  },  "meta": {    "timestamp": "2026-07-14T08:00:00.000Z"  }}

Delete an onboarding source before kickoff

DELETE/organizations/{organizationId}/onboarding/sources/{sourceId}

Path Parameters

organizationId*string

Organization identifier.

Formatuuid

sourceId*string

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/onboarding/sources/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "success": true,  "statusCode": 200,  "message": "Onboarding source deleted.",  "data": {},  "meta": {    "timestamp": "2026-07-14T08:00:00.000Z"  }}

{  "success": false,  "statusCode": 409,  "message": "Onboarding state does not permit this action.",  "error": {    "code": "request_failed"  },  "meta": {    "timestamp": "2026-07-14T08:00:00.000Z"  }}

Store one organization onboarding source

PUT/organizations/{organizationId}/onboarding/sources/{sourceId}

Accepts one raw supported source with a maximum size of 50 MB.

Path Parameters

organizationId*string

Organization identifier.

Formatuuid

sourceId*string

Formatuuid

Query Parameters

department?string

Department evidence scope. Omit for organization-wide evidence.

Value in

"growth"
"engineering"
"support"

kind*string

Value in

"file"
"markdown"

fileName*string

mediaType*string

Request Body

application/octet-stream

TypeScript Definitions

Use the request body type in TypeScript.

body*file

Formatbinary

Response Body

`application/json`

curl -X PUT "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/onboarding/sources/497f6eca-6276-4993-bfeb-53cbbbba6f08?kind=file&fileName=string&mediaType=string" \  -H "Content-Type: application/octet-stream" \  -d 'string'

{  "success": true,  "statusCode": 201,  "message": "Onboarding source stored.",  "data": {},  "meta": {    "timestamp": "2026-07-14T08:00:00.000Z"  }}

{  "success": false,  "statusCode": 400,  "message": "Validation failed.",  "error": {    "code": "request_failed"  },  "meta": {    "timestamp": "2026-07-14T08:00:00.000Z"  }}

{  "success": false,  "statusCode": 413,  "message": "Source files cannot exceed 50 MB.",  "error": {    "code": "request_failed"  },  "meta": {    "timestamp": "2026-07-14T08:00:00.000Z"  }}

{  "success": false,  "statusCode": 415,  "message": "Source type is unsupported.",  "error": {    "code": "request_failed"  },  "meta": {    "timestamp": "2026-07-14T08:00:00.000Z"  }}

Start the organization onboarding chat

POST/organizations/{organizationId}/onboarding/start

Path Parameters

organizationId*string

Organization identifier.

Formatuuid

Response Body

`application/json`

curl -X POST "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/onboarding/start"

{  "success": true,  "statusCode": 200,  "message": "Organization onboarding started.",  "data": {},  "meta": {    "timestamp": "2026-07-14T08:00:00.000Z"  }}

{  "success": false,  "statusCode": 409,  "message": "Onboarding state does not permit this action.",  "error": {    "code": "request_failed"  },  "meta": {    "timestamp": "2026-07-14T08:00:00.000Z"  }}

Activate a reviewed organization

POST/organizations/{organizationId}/onboarding/complete

Path Parameters

organizationId*string

Organization identifier.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/onboarding/complete" \  -H "Content-Type: application/json" \  -d '{    "reviewSha256": "string",    "allowWarnings": true  }'

{  "success": true,  "statusCode": 200,  "message": "Organization onboarding completed.",  "data": {},  "meta": {    "timestamp": "2026-07-14T08:00:00.000Z"  }}

{  "success": false,  "statusCode": 409,  "message": "Onboarding state does not permit this action.",  "error": {    "code": "request_failed"  },  "meta": {    "timestamp": "2026-07-14T08:00:00.000Z"  }}

201application/json

400application/json

409application/json

200application/json

404application/json

200application/json

409application/json

200application/json

409application/json

201application/json

400application/json

413application/json

415application/json

200application/json

409application/json

200application/json

409application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`