Organizations
An organization is your AchieveApex workspace: it owns every contact, deal, conversation and setting. Use this resource to read the organization's settings, wallet balance, plan and usage limits, and to update its general settings.
Endpoints
| Method | Path | Description |
|---|---|---|
GET | /organizations | List organizations |
GET | /organizations/:id | Get an organization |
PATCH | /organizations/:id | Update an organization |
You can only read and update the organizations the API key's user belongs to.
The organization object
json
Numeric money columns (wallet_balance, wallet_auto_recharge_minimum, wallet_auto_recharge_amount, subscription_amount) are decimal columns and may be returned as strings.
Fields
| Field | Type | Description |
|---|---|---|
id | integer | Read-only. Unique ID. |
name | string | Organization name. |
timezone | string | IANA timezone, e.g. America/Bogota. Default UTC. Used for activities, reminders and daily limits. |
logo_url | string | null | Logo URL or storage key. |
default_locale | string | Default language of the organization: en or es. Default en. |
default_phone_country_iso | string | Default phone country, e.g. US. Default US. |
default_phone_country_code | string | Default dialing code, e.g. +1. Default +1. |
wallet_balance | number | Read-only. Prepaid wallet balance in USD, used for AI, messaging and voice usage. Default 0. |
wallet_auto_recharge_enabled | boolean | Recharge the wallet automatically when it falls below wallet_auto_recharge_minimum. Default false. |
wallet_auto_recharge_minimum | number | null | Balance (USD) that triggers an automatic recharge. See the validation rules in Update an organization. |
wallet_auto_recharge_amount | number | null | Amount (USD) charged on each automatic recharge. Must be greater than the minimum. |
wallet_auto_recharge_max_per_day | number | null | Maximum automatic recharges in a rolling 24 hours. |
wallet_auto_recharge_max_per_30_days | number | null | Maximum automatic recharges in a rolling 30 days. |
wallet_auto_recharge_disabled_message | string | null | Read-only. Why automatic recharge was turned off by the system. Cleared when you enable it again. |
channel_webchat_enabled | boolean | Whether the webchat widget channel is enabled. Default false. |
mcp_enabled | boolean | Whether the organization can be used from AI connectors through the AchieveApex MCP server. Default false. |
subscription_plan_name | string | null | Read-only. Current plan. Default Free. |
subscription_status | string | null | Read-only. active, canceled, past_due, trialing, incomplete or incomplete_expired. |
subscription_amount | number | null | Read-only. Price of the plan per billing period. |
billing_interval | string | null | Read-only. day, week, month or year. |
billing_interval_count | number | null | Read-only. Number of intervals per billing period. |
subscription_current_period_start | string (date-time) | null | Read-only. Start of the current billing period. |
subscription_current_period_end | string (date-time) | null | Read-only. End of the current billing period. |
subscription_canceled_at | string (date-time) | null | Read-only. When the subscription was canceled. |
subscription_cancel_at | string (date-time) | null | Read-only. When a scheduled cancellation takes effect. |
subscription_cancel_at_period_end | boolean | null | Read-only. Whether the subscription ends at the end of the current period. |
rate_limit_enabled | boolean | Read-only. Whether API key requests are rate limited. Default true. |
rate_limit_max_requests | number | null | Read-only. Requests allowed per window. Default 1000. |
rate_limit_window_seconds | number | null | Read-only. Rate limit window in seconds. Default 3600. |
automation_limit_daily | number | null | Read-only. Automation runs allowed per day (null = the plan default). |
automation_limit_monthly | number | null | Read-only. Automation runs allowed per month (null = the plan default). |
automation_upgrade_needed_message | string | null | Read-only. Message shown when an automation limit was reached. |
automation_upgrade_needed_reason | string | null | Read-only. daily_limit_reached, monthly_limit_reached or null. |
created_by_user_id | integer | Read-only. User who created the organization. |
created_at | string (date-time) | Read-only. Creation time. |
updated_at | string (date-time) | Read-only. Last update time. |
deleted_at | string (date-time) | null | Read-only. Set when the organization is deleted. |
Related
Report an issue with this documentation
Please log in to report issues with our documentation.