Organizations
List User Organizations
Query Parameters
Search by organization name
Maximum number of items to return (1-200)
501 <= value <= 200Cursor for pagination (from previous response's next_cursor)
Header Parameters
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://loading/v1/orgs"{
"total": 0,
"has_more": false,
"next_cursor": "string",
"organizations": [
{
"organization_id": "string",
"name": "string",
"slug": "string",
"display_name": "string",
"description": "string",
"logo_url": "string",
"website": "string",
"owner_id": "string",
"created_at": "2019-08-24T14:15:22Z",
"user_role": "string"
}
]
}{
"error": "AUTHENTICATION_FAILED",
"message": "Authentication required",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 401
}{
"error": "FORBIDDEN",
"message": "You don't have permission to perform this action",
"details": {
"required_permission": "resource:action"
},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 403
}{
"error": "RESOURCE_NOT_FOUND",
"message": "The requested resource was not found",
"details": {
"resource_type": "example",
"resource_id": "xxx"
},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 404
}{
"error": "CONFLICT",
"message": "Resource already exists",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 409
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}{
"error": "INTERNAL_SERVER_ERROR",
"message": "An unexpected error occurred",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 500
}Create Organization
Header Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://loading/v1/orgs" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "slug": "string" }'{
"organization_id": "string",
"name": "string",
"slug": "string",
"display_name": "string",
"description": "string",
"logo_url": "string",
"website": "string",
"owner_id": "string",
"created_at": "2019-08-24T14:15:22Z",
"user_role": "string"
}{
"error": "AUTHENTICATION_FAILED",
"message": "Authentication required",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 401
}{
"error": "FORBIDDEN",
"message": "You don't have permission to perform this action",
"details": {
"required_permission": "resource:action"
},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 403
}{
"error": "RESOURCE_NOT_FOUND",
"message": "The requested resource was not found",
"details": {
"resource_type": "example",
"resource_id": "xxx"
},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 404
}{
"error": "CONFLICT",
"message": "Resource already exists",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 409
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}{
"error": "INTERNAL_SERVER_ERROR",
"message": "An unexpected error occurred",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 500
}Get Organization
Path Parameters
Header Parameters
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://loading/v1/orgs/string"{
"organization_id": "string",
"name": "string",
"slug": "string",
"display_name": "string",
"description": "string",
"logo_url": "string",
"website": "string",
"owner_id": "string",
"created_at": "2019-08-24T14:15:22Z",
"user_role": "string",
"feature_flags": {
"workspaces_enabled": true,
"apps_enabled": true,
"custom_models_enabled": false,
"vector_search_enabled": true,
"memory_enabled": true,
"sso_enabled": false,
"audit_logs_enabled": false,
"custom_roles_enabled": false,
"workspace_transfer_enabled": false,
"api_access_enabled": true,
"webhooks_enabled": false
},
"usage_limits": {
"max_workspaces": 10,
"max_users": 10,
"max_api_calls_per_month": 100000,
"max_storage_gb": 10,
"max_apps_per_workspace": 50,
"current_workspaces": 0,
"current_users": 0,
"current_api_calls_this_month": 0,
"current_storage_gb": 0
},
"billing": {
"subscription_tier": "free",
"billing_email": "string",
"stripe_customer_id": "string",
"stripe_subscription_id": "string",
"billing_cycle": "monthly",
"next_billing_date": "2019-08-24T14:15:22Z",
"payment_method_last4": "string"
},
"settings": {
"enforce_sso": false,
"require_2fa": false,
"session_timeout_minutes": 480,
"data_retention_days": 365,
"audit_log_retention_days": 90,
"user_event_retention_days": 90,
"admin_event_retention_days": 365,
"default_workspace_retention_days": 30,
"auto_delete_inactive_workspaces": false,
"default_chat_model_id": "string",
"default_embedding_model_id": "string",
"notify_on_new_user": true,
"notify_on_workspace_created": false,
"notify_on_limit_reached": true
},
"updated_at": "2019-08-24T14:15:22Z",
"member_count": 0,
"workspace_count": 0
}{
"error": "AUTHENTICATION_FAILED",
"message": "Authentication required",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 401
}{
"error": "FORBIDDEN",
"message": "You don't have permission to perform this action",
"details": {
"required_permission": "resource:action"
},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 403
}{
"error": "RESOURCE_NOT_FOUND",
"message": "The requested resource was not found",
"details": {
"resource_type": "example",
"resource_id": "xxx"
},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 404
}{
"error": "CONFLICT",
"message": "Resource already exists",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 409
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}{
"error": "INTERNAL_SERVER_ERROR",
"message": "An unexpected error occurred",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 500
}Update Organization
Path Parameters
Header Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://loading/v1/orgs/string" \ -H "Content-Type: application/json" \ -d '{}'{
"organization_id": "string",
"name": "string",
"slug": "string",
"display_name": "string",
"description": "string",
"logo_url": "string",
"website": "string",
"owner_id": "string",
"created_at": "2019-08-24T14:15:22Z",
"user_role": "string"
}{
"error": "AUTHENTICATION_FAILED",
"message": "Authentication required",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 401
}{
"error": "FORBIDDEN",
"message": "You don't have permission to perform this action",
"details": {
"required_permission": "resource:action"
},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 403
}{
"error": "RESOURCE_NOT_FOUND",
"message": "The requested resource was not found",
"details": {
"resource_type": "example",
"resource_id": "xxx"
},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 404
}{
"error": "CONFLICT",
"message": "Resource already exists",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 409
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}{
"error": "INTERNAL_SERVER_ERROR",
"message": "An unexpected error occurred",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 500
}Delete Organization
Path Parameters
Header Parameters
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X DELETE "https://loading/v1/orgs/string"{
"error": "AUTHENTICATION_FAILED",
"message": "Authentication required",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 401
}{
"error": "FORBIDDEN",
"message": "You don't have permission to perform this action",
"details": {
"required_permission": "resource:action"
},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 403
}{
"error": "RESOURCE_NOT_FOUND",
"message": "The requested resource was not found",
"details": {
"resource_type": "example",
"resource_id": "xxx"
},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 404
}{
"error": "CONFLICT",
"message": "Resource already exists",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 409
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}{
"error": "INTERNAL_SERVER_ERROR",
"message": "An unexpected error occurred",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 500
}List Organization Members
Path Parameters
Query Parameters
Search by name or email
Comma-separated list of related data to include (e.g., 'workspaces')
Maximum number of items to return (1-200)
501 <= value <= 200Cursor for pagination (from previous response's next_cursor)
Header Parameters
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://loading/v1/orgs/string/members"{
"total": 0,
"has_more": false,
"next_cursor": "string",
"members": [
null
]
}{
"error": "AUTHENTICATION_FAILED",
"message": "Authentication required",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 401
}{
"error": "FORBIDDEN",
"message": "You don't have permission to perform this action",
"details": {
"required_permission": "resource:action"
},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 403
}{
"error": "RESOURCE_NOT_FOUND",
"message": "The requested resource was not found",
"details": {
"resource_type": "example",
"resource_id": "xxx"
},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 404
}{
"error": "CONFLICT",
"message": "Resource already exists",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 409
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}{
"error": "INTERNAL_SERVER_ERROR",
"message": "An unexpected error occurred",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 500
}Create Organization Member
Path Parameters
Header Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://loading/v1/orgs/string/members" \ -H "Content-Type: application/json" \ -d '{ "email": "string", "username": "string", "password": "stringst" }'{
"member_id": "string",
"user_id": "string",
"role": "string",
"permissions": [
"string"
],
"has_cortex_license": false,
"cortex_licensed_at": "2019-08-24T14:15:22Z",
"joined_at": "2019-08-24T14:15:22Z",
"status": "string",
"username": "string",
"email": "string",
"is_active": true,
"last_login": "2019-08-24T14:15:22Z"
}{
"error": "AUTHENTICATION_FAILED",
"message": "Authentication required",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 401
}{
"error": "FORBIDDEN",
"message": "You don't have permission to perform this action",
"details": {
"required_permission": "resource:action"
},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 403
}{
"error": "RESOURCE_NOT_FOUND",
"message": "The requested resource was not found",
"details": {
"resource_type": "example",
"resource_id": "xxx"
},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 404
}{
"error": "CONFLICT",
"message": "Resource already exists",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 409
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}{
"error": "INTERNAL_SERVER_ERROR",
"message": "An unexpected error occurred",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 500
}Invite User To Organization
Path Parameters
Header Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://loading/v1/orgs/string/invites" \ -H "Content-Type: application/json" \ -d '{ "email": "string" }'{
"invite_id": "string",
"organization_id": "string",
"organization_name": "string",
"email": "string",
"role": "string",
"invited_by": "string",
"expires_at": "2019-08-24T14:15:22Z",
"status": "string"
}{
"error": "AUTHENTICATION_FAILED",
"message": "Authentication required",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 401
}{
"error": "FORBIDDEN",
"message": "You don't have permission to perform this action",
"details": {
"required_permission": "resource:action"
},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 403
}{
"error": "RESOURCE_NOT_FOUND",
"message": "The requested resource was not found",
"details": {
"resource_type": "example",
"resource_id": "xxx"
},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 404
}{
"error": "CONFLICT",
"message": "Resource already exists",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 409
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}{
"error": "INTERNAL_SERVER_ERROR",
"message": "An unexpected error occurred",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 500
}Accept Organization Invite
Path Parameters
Header Parameters
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://loading/v1/orgs/invites/string/accept"{
"organization_id": "string",
"name": "string",
"slug": "string",
"display_name": "string",
"description": "string",
"logo_url": "string",
"website": "string",
"owner_id": "string",
"created_at": "2019-08-24T14:15:22Z",
"user_role": "string"
}{
"error": "AUTHENTICATION_FAILED",
"message": "Authentication required",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 401
}{
"error": "FORBIDDEN",
"message": "You don't have permission to perform this action",
"details": {
"required_permission": "resource:action"
},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 403
}{
"error": "RESOURCE_NOT_FOUND",
"message": "The requested resource was not found",
"details": {
"resource_type": "example",
"resource_id": "xxx"
},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 404
}{
"error": "CONFLICT",
"message": "Resource already exists",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 409
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}{
"error": "INTERNAL_SERVER_ERROR",
"message": "An unexpected error occurred",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 500
}Update Member Role
Path Parameters
Query Parameters
^(org_admin|org_member)$Header Parameters
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://loading/v1/orgs/string/members/string/role?new_role=string"null{
"error": "AUTHENTICATION_FAILED",
"message": "Authentication required",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 401
}{
"error": "FORBIDDEN",
"message": "You don't have permission to perform this action",
"details": {
"required_permission": "resource:action"
},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 403
}{
"error": "RESOURCE_NOT_FOUND",
"message": "The requested resource was not found",
"details": {
"resource_type": "example",
"resource_id": "xxx"
},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 404
}{
"error": "CONFLICT",
"message": "Resource already exists",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 409
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}{
"error": "INTERNAL_SERVER_ERROR",
"message": "An unexpected error occurred",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 500
}Update Member Permissions
Path Parameters
Header Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://loading/v1/orgs/string/members/string/permissions" \ -H "Content-Type: application/json" \ -d '{}'null{
"error": "AUTHENTICATION_FAILED",
"message": "Authentication required",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 401
}{
"error": "FORBIDDEN",
"message": "You don't have permission to perform this action",
"details": {
"required_permission": "resource:action"
},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 403
}{
"error": "RESOURCE_NOT_FOUND",
"message": "The requested resource was not found",
"details": {
"resource_type": "example",
"resource_id": "xxx"
},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 404
}{
"error": "CONFLICT",
"message": "Resource already exists",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 409
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}{
"error": "INTERNAL_SERVER_ERROR",
"message": "An unexpected error occurred",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 500
}Remove Organization Member
Path Parameters
Header Parameters
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X DELETE "https://loading/v1/orgs/string/members/string"{
"error": "AUTHENTICATION_FAILED",
"message": "Authentication required",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 401
}{
"error": "FORBIDDEN",
"message": "You don't have permission to perform this action",
"details": {
"required_permission": "resource:action"
},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 403
}{
"error": "RESOURCE_NOT_FOUND",
"message": "The requested resource was not found",
"details": {
"resource_type": "example",
"resource_id": "xxx"
},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 404
}{
"error": "CONFLICT",
"message": "Resource already exists",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 409
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}{
"error": "INTERNAL_SERVER_ERROR",
"message": "An unexpected error occurred",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 500
}Get Current Organization
Query Parameters
Organization ID to switch to
Header Parameters
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://loading/v1/orgs/current"{
"organization_id": "string",
"name": "string",
"slug": "string",
"display_name": "string",
"description": "string",
"logo_url": "string",
"website": "string",
"owner_id": "string",
"created_at": "2019-08-24T14:15:22Z",
"user_role": "string"
}{
"error": "AUTHENTICATION_FAILED",
"message": "Authentication required",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 401
}{
"error": "FORBIDDEN",
"message": "You don't have permission to perform this action",
"details": {
"required_permission": "resource:action"
},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 403
}{
"error": "RESOURCE_NOT_FOUND",
"message": "The requested resource was not found",
"details": {
"resource_type": "example",
"resource_id": "xxx"
},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 404
}{
"error": "CONFLICT",
"message": "Resource already exists",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 409
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}{
"error": "INTERNAL_SERVER_ERROR",
"message": "An unexpected error occurred",
"details": {},
"timestamp": "2025-01-01T00:00:00.000000",
"status_code": 500
}