Organizations

Endpointhttps://api.neuratel.ai

Organization management, memberships, and invites.

List organizations

GET

https://api.neuratel.ai

/v1/organizations/

List all organizations (super admin only)

List organizations › Responses

200

Successful Response

object[]

Schema for organization response

id

string · uuid · required

name

string · required

slug

string · required

owner_email

string · email · required

status

string · required

created_at

string · date-time · required

updated_at

string · date-time · required

max_agents

integer

Default: 3

max_members

integer

Default: 5

max_concurrent_calls

integer

Default: 5

billing_currency

string

Default: USD

auto_reload_enabled

boolean

Default: false

sku

string

Default: pilot

contract_term

string

Default: month

payment_method

string

Default: stripe_card

stripe_balance_mirror_enabled

boolean

Default: true

bank_payment_terms_days

integer

Default: 15

payment_failed

boolean

Default: false

india_dlt_registered

boolean

Default: false

object

month_to_date_billable_minutes_cache

string · pattern: ^(?!^[-+.]*$)[+-]?0*…

Default: 0

month_to_date_whatsapp_call_minutes_cache

string · pattern: ^(?!^[-+.]*$)[+-]?0*…

Default: 0

scale_cap_override

boolean

Default: false

GET/v1/organizations/

curl --request GET \
  --url https://api.neuratel.ai/v1/organizations/

shell

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "supertokens_tenant_id": "string",
    "name": "name",
    "slug": "slug",
    "owner_email": "[email protected]",
    "logo_url": "string",
    "max_agents": 3,
    "max_members": 5,
    "max_concurrent_calls": 5,
    "billing_currency": "USD",
    "stripe_customer_id": "string",
    "stripe_subscription_id": "string",
    "auto_reload_enabled": false,
    "auto_reload_threshold_cents": 0,
    "auto_reload_amount_cents": 0,
    "sku": "pilot",
    "contract_term": "month",
    "payment_method": "stripe_card",
    "stripe_balance_mirror_enabled": true,
    "invoice_billing_email": "string",
    "bank_payment_terms_days": 15,
    "low_balance_manual_alert_threshold_cents": 0,
    "payment_failed": false,
    "payment_failed_reason": "string",
    "india_dlt_registered": false,
    "custom_rate_overrides": {},
    "month_to_date_billable_minutes_cache": "0",
    "month_to_date_whatsapp_call_minutes_cache": "0",
    "pilot_started_at": "2024-08-25T15:00:00Z",
    "pilot_go_live_at": "2024-08-25T15:00:00Z",
    "pilot_status": "string",
    "pilot_included_minutes_used": "string",
    "pilot_included_messages_used": 0,
    "pilot_conversion_call_alerted_at": "2024-08-25T15:00:00Z",
    "setup_fee_invoice_id": "00000000-0000-0000-0000-000000000000",
    "scale_waiver_applied_at": "2024-08-25T15:00:00Z",
    "scale_cap_override": false,
    "website": "string",
    "email": "string",
    "openai_api_key": "string",
    "deepgram_api_key": "string",
    "soniox_api_key": "string",
    "groq_api_key": "string",
    "cartesia_api_key": "string",
    "permissions": {},
    "status": "status",
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
]

json

application/json

Create organization

POST

https://api.neuratel.ai

/v1/organizations/

Create a new organization.

Create organization › Request Body

Schema for creating a new organization

name

string · minLength: 1 · maxLength: 255 · required

sku

string · enum

Enum values:

pilot

launch

scale

Default: pilot

Create organization › Responses

Successful Response

Schema for organization response

id

string · uuid · required

name

string · required

slug

string · required

owner_email

string · email · required

status

string · required

created_at

string · date-time · required

updated_at

string · date-time · required

max_agents

integer

Default: 3

max_members

integer

Default: 5

max_concurrent_calls

integer

Default: 5

billing_currency

string

Default: USD

auto_reload_enabled

boolean

Default: false

sku

string

Default: pilot

contract_term

string

Default: month

payment_method

string

Default: stripe_card

stripe_balance_mirror_enabled

boolean

Default: true

bank_payment_terms_days

integer

Default: 15

payment_failed

boolean

Default: false

india_dlt_registered

boolean

Default: false

object

month_to_date_billable_minutes_cache

string · pattern: ^(?!^[-+.]*$)[+-]?0*…

Default: 0

month_to_date_whatsapp_call_minutes_cache

string · pattern: ^(?!^[-+.]*$)[+-]?0*…

Default: 0

scale_cap_override

boolean

Default: false

POST/v1/organizations/

curl --request POST \
  --url https://api.neuratel.ai/v1/organizations/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "slug": "string",
  "logo_url": "string",
  "sku": "pilot",
  "website": "string",
  "email": "string"
}
'

shell

Example Request Body

{
  "name": "name",
  "slug": "string",
  "logo_url": "string",
  "sku": "pilot",
  "website": "string",
  "email": "string"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "supertokens_tenant_id": "string",
  "name": "name",
  "slug": "slug",
  "owner_email": "[email protected]",
  "logo_url": "string",
  "max_agents": 3,
  "max_members": 5,
  "max_concurrent_calls": 5,
  "billing_currency": "USD",
  "stripe_customer_id": "string",
  "stripe_subscription_id": "string",
  "auto_reload_enabled": false,
  "auto_reload_threshold_cents": 0,
  "auto_reload_amount_cents": 0,
  "sku": "pilot",
  "contract_term": "month",
  "payment_method": "stripe_card",
  "stripe_balance_mirror_enabled": true,
  "invoice_billing_email": "string",
  "bank_payment_terms_days": 15,
  "low_balance_manual_alert_threshold_cents": 0,
  "payment_failed": false,
  "payment_failed_reason": "string",
  "india_dlt_registered": false,
  "custom_rate_overrides": {},
  "month_to_date_billable_minutes_cache": "0",
  "month_to_date_whatsapp_call_minutes_cache": "0",
  "pilot_started_at": "2024-08-25T15:00:00Z",
  "pilot_go_live_at": "2024-08-25T15:00:00Z",
  "pilot_status": "string",
  "pilot_included_minutes_used": "string",
  "pilot_included_messages_used": 0,
  "pilot_conversion_call_alerted_at": "2024-08-25T15:00:00Z",
  "setup_fee_invoice_id": "00000000-0000-0000-0000-000000000000",
  "scale_waiver_applied_at": "2024-08-25T15:00:00Z",
  "scale_cap_override": false,
  "website": "string",
  "email": "string",
  "openai_api_key": "string",
  "deepgram_api_key": "string",
  "soniox_api_key": "string",
  "groq_api_key": "string",
  "cartesia_api_key": "string",
  "permissions": {},
  "status": "status",
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Get my organization

GET

https://api.neuratel.ai

/v1/organizations/me

Get the current user's organization.

Get my organization › Responses

200

Successful Response

Schema for organization response

id

string · uuid · required

name

string · required

slug

string · required

owner_email

string · email · required

status

string · required

created_at

string · date-time · required

updated_at

string · date-time · required

max_agents

integer

Default: 3

max_members

integer

Default: 5

max_concurrent_calls

integer

Default: 5

billing_currency

string

Default: USD

auto_reload_enabled

boolean

Default: false

sku

string

Default: pilot

contract_term

string

Default: month

payment_method

string

Default: stripe_card

stripe_balance_mirror_enabled

boolean

Default: true

bank_payment_terms_days

integer

Default: 15

payment_failed

boolean

Default: false

india_dlt_registered

boolean

Default: false

object

month_to_date_billable_minutes_cache

string · pattern: ^(?!^[-+.]*$)[+-]?0*…

Default: 0

month_to_date_whatsapp_call_minutes_cache

string · pattern: ^(?!^[-+.]*$)[+-]?0*…

Default: 0

scale_cap_override

boolean

Default: false

GET/v1/organizations/me

curl --request GET \
  --url https://api.neuratel.ai/v1/organizations/me

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "supertokens_tenant_id": "string",
  "name": "name",
  "slug": "slug",
  "owner_email": "[email protected]",
  "logo_url": "string",
  "max_agents": 3,
  "max_members": 5,
  "max_concurrent_calls": 5,
  "billing_currency": "USD",
  "stripe_customer_id": "string",
  "stripe_subscription_id": "string",
  "auto_reload_enabled": false,
  "auto_reload_threshold_cents": 0,
  "auto_reload_amount_cents": 0,
  "sku": "pilot",
  "contract_term": "month",
  "payment_method": "stripe_card",
  "stripe_balance_mirror_enabled": true,
  "invoice_billing_email": "string",
  "bank_payment_terms_days": 15,
  "low_balance_manual_alert_threshold_cents": 0,
  "payment_failed": false,
  "payment_failed_reason": "string",
  "india_dlt_registered": false,
  "custom_rate_overrides": {},
  "month_to_date_billable_minutes_cache": "0",
  "month_to_date_whatsapp_call_minutes_cache": "0",
  "pilot_started_at": "2024-08-25T15:00:00Z",
  "pilot_go_live_at": "2024-08-25T15:00:00Z",
  "pilot_status": "string",
  "pilot_included_minutes_used": "string",
  "pilot_included_messages_used": 0,
  "pilot_conversion_call_alerted_at": "2024-08-25T15:00:00Z",
  "setup_fee_invoice_id": "00000000-0000-0000-0000-000000000000",
  "scale_waiver_applied_at": "2024-08-25T15:00:00Z",
  "scale_cap_override": false,
  "website": "string",
  "email": "string",
  "openai_api_key": "string",
  "deepgram_api_key": "string",
  "soniox_api_key": "string",
  "groq_api_key": "string",
  "cartesia_api_key": "string",
  "permissions": {},
  "status": "status",
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Get organization by ID

GET

https://api.neuratel.ai

/v1/organizations/{org_id}

Get organization by database UUID.

Super admin: can access any org
Regular user: can only access their own org

Get organization by ID › path Parameters

org_id

string · uuid · required

Get organization by ID › Responses

Successful Response

Schema for organization response

id

string · uuid · required

name

string · required

slug

string · required

owner_email

string · email · required

status

string · required

created_at

string · date-time · required

updated_at

string · date-time · required

max_agents

integer

Default: 3

max_members

integer

Default: 5

max_concurrent_calls

integer

Default: 5

billing_currency

string

Default: USD

auto_reload_enabled

boolean

Default: false

sku

string

Default: pilot

contract_term

string

Default: month

payment_method

string

Default: stripe_card

stripe_balance_mirror_enabled

boolean

Default: true

bank_payment_terms_days

integer

Default: 15

payment_failed

boolean

Default: false

india_dlt_registered

boolean

Default: false

object

month_to_date_billable_minutes_cache

string · pattern: ^(?!^[-+.]*$)[+-]?0*…

Default: 0

month_to_date_whatsapp_call_minutes_cache

string · pattern: ^(?!^[-+.]*$)[+-]?0*…

Default: 0

scale_cap_override

boolean

Default: false

GET/v1/organizations/{org_id}

curl --request GET \
  --url https://api.neuratel.ai/v1/organizations/:org_id

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "supertokens_tenant_id": "string",
  "name": "name",
  "slug": "slug",
  "owner_email": "[email protected]",
  "logo_url": "string",
  "max_agents": 3,
  "max_members": 5,
  "max_concurrent_calls": 5,
  "billing_currency": "USD",
  "stripe_customer_id": "string",
  "stripe_subscription_id": "string",
  "auto_reload_enabled": false,
  "auto_reload_threshold_cents": 0,
  "auto_reload_amount_cents": 0,
  "sku": "pilot",
  "contract_term": "month",
  "payment_method": "stripe_card",
  "stripe_balance_mirror_enabled": true,
  "invoice_billing_email": "string",
  "bank_payment_terms_days": 15,
  "low_balance_manual_alert_threshold_cents": 0,
  "payment_failed": false,
  "payment_failed_reason": "string",
  "india_dlt_registered": false,
  "custom_rate_overrides": {},
  "month_to_date_billable_minutes_cache": "0",
  "month_to_date_whatsapp_call_minutes_cache": "0",
  "pilot_started_at": "2024-08-25T15:00:00Z",
  "pilot_go_live_at": "2024-08-25T15:00:00Z",
  "pilot_status": "string",
  "pilot_included_minutes_used": "string",
  "pilot_included_messages_used": 0,
  "pilot_conversion_call_alerted_at": "2024-08-25T15:00:00Z",
  "setup_fee_invoice_id": "00000000-0000-0000-0000-000000000000",
  "scale_waiver_applied_at": "2024-08-25T15:00:00Z",
  "scale_cap_override": false,
  "website": "string",
  "email": "string",
  "openai_api_key": "string",
  "deepgram_api_key": "string",
  "soniox_api_key": "string",
  "groq_api_key": "string",
  "cartesia_api_key": "string",
  "permissions": {},
  "status": "status",
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Delete organization

DELETE

https://api.neuratel.ai

/v1/organizations/{org_id}

Delete an organization. Super admin only.

Delete organization › path Parameters

org_id

string · uuid · required

Delete organization › Responses

Successful Response

No data returned

Upload organization logo

POST

https://api.neuratel.ai

/v1/organizations/{org_id}/logo

Upload organization logo.

Accepts image files (jpg, jpeg, png, gif, webp).

Upload organization logo › path Parameters

org_id

string · uuid · required

Upload organization logo › Request Body

file

string · required

Upload organization logo › Responses

Successful Response

string

Update organization permissions

PATCH

https://api.neuratel.ai

/v1/organizations/{org_id}/permissions

Update organization permissions and settings.

Note: This updates business settings stored in our DB.

Update organization permissions › path Parameters

org_id

string · uuid · required

Update organization permissions › Request Body

Schema for updating organization settings and credentials

Update organization permissions › Responses

Successful Response

Schema for organization response

id

string · uuid · required

name

string · required

slug

string · required

owner_email

string · email · required

status

string · required

created_at

string · date-time · required

updated_at

string · date-time · required

max_agents

integer

Default: 3

max_members

integer

Default: 5

max_concurrent_calls

integer

Default: 5

billing_currency

string

Default: USD

auto_reload_enabled

boolean

Default: false

sku

string

Default: pilot

contract_term

string

Default: month

payment_method

string

Default: stripe_card

stripe_balance_mirror_enabled

boolean

Default: true

bank_payment_terms_days

integer

Default: 15

payment_failed

boolean

Default: false

india_dlt_registered

boolean

Default: false

object

month_to_date_billable_minutes_cache

string · pattern: ^(?!^[-+.]*$)[+-]?0*…

Default: 0

month_to_date_whatsapp_call_minutes_cache

string · pattern: ^(?!^[-+.]*$)[+-]?0*…

Default: 0

scale_cap_override

boolean

Default: false

PATCH/v1/organizations/{org_id}/permissions

curl --request PATCH \
  --url https://api.neuratel.ai/v1/organizations/:org_id/permissions \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "string",
  "max_agents": 0,
  "max_members": 0,
  "max_concurrent_calls": 0,
  "billing_currency": "string",
  "sku": "pilot",
  "contract_term": "month",
  "payment_method": "stripe_card",
  "bank_payment_terms_days": 1,
  "low_balance_manual_alert_threshold_cents": 0,
  "invoice_billing_email": "string",
  "stripe_balance_mirror_enabled": true,
  "website": "string",
  "email": "string",
  "openai_api_key": "string",
  "deepgram_api_key": "string",
  "soniox_api_key": "string",
  "groq_api_key": "string",
  "cartesia_api_key": "string"
}
'

shell

Example Request Body

{
  "name": "string",
  "max_agents": 0,
  "max_members": 0,
  "max_concurrent_calls": 0,
  "billing_currency": "string",
  "sku": "pilot",
  "contract_term": "month",
  "payment_method": "stripe_card",
  "bank_payment_terms_days": 1,
  "low_balance_manual_alert_threshold_cents": 0,
  "invoice_billing_email": "string",
  "stripe_balance_mirror_enabled": true,
  "website": "string",
  "email": "string",
  "openai_api_key": "string",
  "deepgram_api_key": "string",
  "soniox_api_key": "string",
  "groq_api_key": "string",
  "cartesia_api_key": "string"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "supertokens_tenant_id": "string",
  "name": "name",
  "slug": "slug",
  "owner_email": "[email protected]",
  "logo_url": "string",
  "max_agents": 3,
  "max_members": 5,
  "max_concurrent_calls": 5,
  "billing_currency": "USD",
  "stripe_customer_id": "string",
  "stripe_subscription_id": "string",
  "auto_reload_enabled": false,
  "auto_reload_threshold_cents": 0,
  "auto_reload_amount_cents": 0,
  "sku": "pilot",
  "contract_term": "month",
  "payment_method": "stripe_card",
  "stripe_balance_mirror_enabled": true,
  "invoice_billing_email": "string",
  "bank_payment_terms_days": 15,
  "low_balance_manual_alert_threshold_cents": 0,
  "payment_failed": false,
  "payment_failed_reason": "string",
  "india_dlt_registered": false,
  "custom_rate_overrides": {},
  "month_to_date_billable_minutes_cache": "0",
  "month_to_date_whatsapp_call_minutes_cache": "0",
  "pilot_started_at": "2024-08-25T15:00:00Z",
  "pilot_go_live_at": "2024-08-25T15:00:00Z",
  "pilot_status": "string",
  "pilot_included_minutes_used": "string",
  "pilot_included_messages_used": 0,
  "pilot_conversion_call_alerted_at": "2024-08-25T15:00:00Z",
  "setup_fee_invoice_id": "00000000-0000-0000-0000-000000000000",
  "scale_waiver_applied_at": "2024-08-25T15:00:00Z",
  "scale_cap_override": false,
  "website": "string",
  "email": "string",
  "openai_api_key": "string",
  "deepgram_api_key": "string",
  "soniox_api_key": "string",
  "groq_api_key": "string",
  "cartesia_api_key": "string",
  "permissions": {},
  "status": "status",
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Update organization credentials

PUT

https://api.neuratel.ai

/v1/organizations/{org_id}/credentials

Update organization API credentials.

Only super admins can update credentials for any organization. Org members with manage_credentials permission can update their own org.

Update organization credentials › path Parameters

org_id

string · uuid · required

Update organization credentials › Request Body

Schema for updating organization API credentials only

Update organization credentials › Responses

Successful Response

Schema for organization response

id

string · uuid · required

name

string · required

slug

string · required

owner_email

string · email · required

status

string · required

created_at

string · date-time · required

updated_at

string · date-time · required

max_agents

integer

Default: 3

max_members

integer

Default: 5

max_concurrent_calls

integer

Default: 5

billing_currency

string

Default: USD

auto_reload_enabled

boolean

Default: false

sku

string

Default: pilot

contract_term

string

Default: month

payment_method

string

Default: stripe_card

stripe_balance_mirror_enabled

boolean

Default: true

bank_payment_terms_days

integer

Default: 15

payment_failed

boolean

Default: false

india_dlt_registered

boolean

Default: false

object

month_to_date_billable_minutes_cache

string · pattern: ^(?!^[-+.]*$)[+-]?0*…

Default: 0

month_to_date_whatsapp_call_minutes_cache

string · pattern: ^(?!^[-+.]*$)[+-]?0*…

Default: 0

scale_cap_override

boolean

Default: false

PUT/v1/organizations/{org_id}/credentials

curl --request PUT \
  --url https://api.neuratel.ai/v1/organizations/:org_id/credentials \
  --header 'Content-Type: application/json' \
  --data '
{
  "openai_api_key": "string",
  "deepgram_api_key": "string",
  "soniox_api_key": "string",
  "groq_api_key": "string",
  "cartesia_api_key": "string"
}
'

shell

Example Request Body

{
  "openai_api_key": "string",
  "deepgram_api_key": "string",
  "soniox_api_key": "string",
  "groq_api_key": "string",
  "cartesia_api_key": "string"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "supertokens_tenant_id": "string",
  "name": "name",
  "slug": "slug",
  "owner_email": "[email protected]",
  "logo_url": "string",
  "max_agents": 3,
  "max_members": 5,
  "max_concurrent_calls": 5,
  "billing_currency": "USD",
  "stripe_customer_id": "string",
  "stripe_subscription_id": "string",
  "auto_reload_enabled": false,
  "auto_reload_threshold_cents": 0,
  "auto_reload_amount_cents": 0,
  "sku": "pilot",
  "contract_term": "month",
  "payment_method": "stripe_card",
  "stripe_balance_mirror_enabled": true,
  "invoice_billing_email": "string",
  "bank_payment_terms_days": 15,
  "low_balance_manual_alert_threshold_cents": 0,
  "payment_failed": false,
  "payment_failed_reason": "string",
  "india_dlt_registered": false,
  "custom_rate_overrides": {},
  "month_to_date_billable_minutes_cache": "0",
  "month_to_date_whatsapp_call_minutes_cache": "0",
  "pilot_started_at": "2024-08-25T15:00:00Z",
  "pilot_go_live_at": "2024-08-25T15:00:00Z",
  "pilot_status": "string",
  "pilot_included_minutes_used": "string",
  "pilot_included_messages_used": 0,
  "pilot_conversion_call_alerted_at": "2024-08-25T15:00:00Z",
  "setup_fee_invoice_id": "00000000-0000-0000-0000-000000000000",
  "scale_waiver_applied_at": "2024-08-25T15:00:00Z",
  "scale_cap_override": false,
  "website": "string",
  "email": "string",
  "openai_api_key": "string",
  "deepgram_api_key": "string",
  "soniox_api_key": "string",
  "groq_api_key": "string",
  "cartesia_api_key": "string",
  "permissions": {},
  "status": "status",
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

List organization members

GET

https://api.neuratel.ai

/v1/organizations/{org_id}/members

List all members of the organization. Requires admin permissions.

List organization members › path Parameters

org_id

string · uuid · required

List organization members › Responses

Successful Response

List of organization members.

object[] · required

total_count

integer · required

List pending invitations

GET

https://api.neuratel.ai

/v1/organizations/{org_id}/invitations

List all pending invitations for the organization. Requires admin permissions.

List pending invitations › path Parameters

org_id

string · uuid · required

List pending invitations › query Parameters

status

string

Filter by status: pending, accepted, revoked

Default: pending

List pending invitations › Responses

Successful Response

List of pending invitations.

object[] · required

total_count

integer · required

Invite a team member

POST

https://api.neuratel.ai

/v1/organizations/{org_id}/invitations

Send an invitation to join the organization. Requires admin permissions.

Invite a team member › path Parameters

org_id

string · uuid · required

Invite a team member › Request Body

Request to invite a member to an organization. Roles: admin, operator, viewer. Permissions come from role.

email

string · email · required

role

string · enum

Enum values:

admin

operator

viewer

Default: operator

Invite a team member › Responses

Successful Response

A pending invitation.

id

string · required

email

string · required

role

string · required

status

string · required

created_at

string · required

Revoke an invitation

DELETE

https://api.neuratel.ai

/v1/organizations/{org_id}/invitations/{invitation_id}

Revoke a pending invitation. Requires admin permissions.

Revoke an invitation › path Parameters

org_id

string · uuid · required

invitation_id

string · required

The invitation ID to revoke

Revoke an invitation › Responses

Successful Response

No data returned

Remove a team member

DELETE

https://api.neuratel.ai

/v1/organizations/{org_id}/members/{user_id}

Remove a member from the organization. Requires admin permissions.

Remove a team member › path Parameters

org_id

string · uuid · required

user_id

string · required

The user ID to remove

Remove a team member › Responses

Successful Response

No data returned

Update member role

PATCH

https://api.neuratel.ai

/v1/organizations/{org_id}/members/{user_id}/role

Update a member's role in the organization. Requires admin permissions.

Update member role › path Parameters

org_id

string · uuid · required

user_id

string · required

The user ID to update

Update member role › query Parameters

role

string

The new role (admin or operator) - deprecated, use request body

Update member role › Request Body

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object · requires: role
	type = null

Properties for UpdateRoleRequest:

Request to update a member's role.

role

string · enum · required

Enum values:

admin

operator

viewer

Update member role › Responses

Successful Response

A team member in the organization.

id

string · required

email

string · required

role

string · required

Get invitation details

GET

https://api.neuratel.ai

/v1/organizations/invitations/{invitation_id}

Get invitation details by ID (public route — no auth required). Returns org name, invitee email, and whether user already has an account.

Get invitation details › path Parameters

invitation_id

string · required

Get invitation details › Responses

Successful Response

No data returned

Register and accept invitation

POST

https://api.neuratel.ai

/v1/organizations/invitations/{invitation_id}/register-and-accept

Register and accept invitation › path Parameters

invitation_id

string · required

Register and accept invitation › Request Body

Request body for registering a new user and accepting invitation.

name

string · minLength: 1 · maxLength: 128 · required

User's display name

password

string · minLength: 8 · maxLength: 128 · required

Account password

Register and accept invitation › Responses

Successful Response

No data returned

Accept invitation

POST

https://api.neuratel.ai

/v1/organizations/invitations/{invitation_id}/accept

Accept an invitation (authenticated user whose email matches the invitee).

Accept invitation › path Parameters

invitation_id

string · required

Accept invitation › Responses

Successful Response

No data returned

Onboarding completion state

GET

https://api.neuratel.ai

/v1/organizations/me/onboarding

Onboarding completion state › Responses

200

Successful Response

Used by the FE to decide whether /outbound should redirect into the first-run wizard. ``completed_at`` is null until the user has either completed or explicitly skipped onboarding.

Mark onboarding completed (or skipped)

POST

https://api.neuratel.ai

/v1/organizations/me/onboarding/complete

Stamps onboarding_completed_at = now(). Idempotent — calling again returns the original timestamp. The FE calls this both on the wizard's Launch path and on its Skip link so future visits no longer redirect into onboarding.

Mark onboarding completed (or skipped) › Responses

200

Successful Response

Used by the FE to decide whether /outbound should redirect into the first-run wizard. ``completed_at`` is null until the user has either completed or explicitly skipped onboarding.

Webhooks Billing