For the complete documentation index, see llms.txt. This page is also available as Markdown.

Organizations

Create Organization

post
Authorizations
x-api-keystringRequired
Body
billing_user_idstring · nullableOptional

User ID to act as billing user; defaults to owner.

Default: null
namestringOptional

Unique (case-insensitive) organization name.

Responses
200

Successful response

application/json
billing_user_idanyRead-onlyOptional
is_deletedbooleanOptional
namestringOptional
organization_idstringOptional
owner_idanyRead-onlyOptional
usersanyRead-onlyOptional
post/v3/organizations/
POST /v3/organizations/ HTTP/1.1
Host: api:8080
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "billing_user_id": "text",
  "name": "text"
}
{
  "billing_user_id": null,
  "is_deleted": true,
  "name": "text",
  "organization_id": "text",
  "owner_id": null,
  "users": null
}

Accept Organization Invitation

post
Authorizations
x-api-keystringRequired
Body
tokenstringRequired
Responses
200

Successful response

application/json
emailanyRead-onlyOptional
inherits_subscriptionbooleanOptional
membership_idanyRead-onlyOptional
nameanyRead-onlyOptional
roleanyRead-onlyOptional
statusanyRead-onlyOptional
user_idanyRead-onlyOptional
post/v3/organizations/invitations/accept
POST /v3/organizations/invitations/accept HTTP/1.1
Host: api:8080
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "token": "text"
}
{
  "email": null,
  "inherits_subscription": true,
  "membership_id": null,
  "name": null,
  "role": null,
  "status": null,
  "user_id": null
}

Retrieve Organization

get
Authorizations
x-api-keystringRequired
Path parameters
idstringRequired
Responses
200

Successful response

application/json
billing_user_idanyRead-onlyOptional
is_deletedbooleanOptional
namestringOptional
organization_idstringOptional
owner_idanyRead-onlyOptional
usersanyRead-onlyOptional
get/v3/organizations/{id}
GET /v3/organizations/{id} HTTP/1.1
Host: api:8080
x-api-key: YOUR_API_KEY
Accept: */*
{
  "billing_user_id": null,
  "is_deleted": true,
  "name": "text",
  "organization_id": "text",
  "owner_id": null,
  "users": null
}

Delete Organization

delete
Authorizations
x-api-keystringRequired
Path parameters
idstringRequired
Responses
200

Successful response

application/json
anyOptional
delete/v3/organizations/{id}
DELETE /v3/organizations/{id} HTTP/1.1
Host: api:8080
x-api-key: YOUR_API_KEY
Accept: */*

No content

Update Organization

patch
Authorizations
x-api-keystringRequired
Path parameters
idstringRequired
Body
billing_user_idstring · nullableOptional

User ID to act as billing user; defaults to owner.

Default: null
namestring · nullableOptional

Unique (case-insensitive) organization name.

Default: null
Responses
200

Successful response

application/json
billing_user_idanyRead-onlyOptional
is_deletedbooleanOptional
namestringOptional
organization_idstringOptional
owner_idanyRead-onlyOptional
usersanyRead-onlyOptional
patch/v3/organizations/{id}
PATCH /v3/organizations/{id} HTTP/1.1
Host: api:8080
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "billing_user_id": "text",
  "name": "text"
}
{
  "billing_user_id": null,
  "is_deleted": true,
  "name": "text",
  "organization_id": "text",
  "owner_id": null,
  "users": null
}

Invite Organization User

post
Authorizations
x-api-keystringRequired
Path parameters
idstringRequired
Body
emailstringRequired
inherits_subscriptionbooleanOptionalDefault: true
namestring · nullableOptionalDefault: null
rolestringOptionalDefault: member
Responses
200

Successful response

application/json
tokenstringRequired
post/v3/organizations/{id}/invitations
POST /v3/organizations/{id}/invitations HTTP/1.1
Host: api:8080
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "email": "text",
  "inherits_subscription": true,
  "name": "text",
  "role": "member"
}
{
  "token": "text"
}

List Organization Users

get
Authorizations
x-api-keystringRequired
Path parameters
idstringRequired
Responses
200

Successful response

application/json
get/v3/organizations/{id}/users
GET /v3/organizations/{id}/users HTTP/1.1
Host: api:8080
x-api-key: YOUR_API_KEY
Accept: */*
{
  "users": [
    {
      "email": null,
      "inherits_subscription": true,
      "membership_id": null,
      "name": null,
      "role": null,
      "status": null,
      "user_id": null
    }
  ]
}

Remove Organization User

delete
Authorizations
x-api-keystringRequired
Path parameters
idstringRequired
Body
membership_idstringRequired
Responses
200

Successful response

application/json
anyOptional
delete/v3/organizations/{id}/users
DELETE /v3/organizations/{id}/users HTTP/1.1
Host: api:8080
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "membership_id": "text"
}

No content

Update Organization User

patch
Authorizations
x-api-keystringRequired
Path parameters
idstringRequired
membership_idstringRequired
Body
inherits_subscriptionboolean · nullableOptionalDefault: null
namestring · nullableOptionalDefault: null
rolestring · nullableOptionalDefault: null
Responses
200

Successful response

application/json
emailanyRead-onlyOptional
inherits_subscriptionbooleanOptional
membership_idanyRead-onlyOptional
nameanyRead-onlyOptional
roleanyRead-onlyOptional
statusanyRead-onlyOptional
user_idanyRead-onlyOptional
patch/v3/organizations/{id}/users/{membership_id}
PATCH /v3/organizations/{id}/users/{membership_id} HTTP/1.1
Host: api:8080
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "inherits_subscription": true,
  "name": "text",
  "role": "text"
}
{
  "email": null,
  "inherits_subscription": true,
  "membership_id": null,
  "name": null,
  "role": null,
  "status": null,
  "user_id": null
}

Last updated

Was this helpful?