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

MethodPathDescription
GET/organizationsList organizations
GET/organizations/:idGet an organization
PATCH/organizations/:idUpdate 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

FieldTypeDescription
idintegerRead-only. Unique ID.
namestringOrganization name.
timezonestringIANA timezone, e.g. America/Bogota. Default UTC. Used for activities, reminders and daily limits.
logo_urlstring | nullLogo URL or storage key.
default_localestringDefault language of the organization: en or es. Default en.
default_phone_country_isostringDefault phone country, e.g. US. Default US.
default_phone_country_codestringDefault dialing code, e.g. +1. Default +1.
wallet_balancenumberRead-only. Prepaid wallet balance in USD, used for AI, messaging and voice usage. Default 0.
wallet_auto_recharge_enabledbooleanRecharge the wallet automatically when it falls below wallet_auto_recharge_minimum. Default false.
wallet_auto_recharge_minimumnumber | nullBalance (USD) that triggers an automatic recharge. See the validation rules in Update an organization.
wallet_auto_recharge_amountnumber | nullAmount (USD) charged on each automatic recharge. Must be greater than the minimum.
wallet_auto_recharge_max_per_daynumber | nullMaximum automatic recharges in a rolling 24 hours.
wallet_auto_recharge_max_per_30_daysnumber | nullMaximum automatic recharges in a rolling 30 days.
wallet_auto_recharge_disabled_messagestring | nullRead-only. Why automatic recharge was turned off by the system. Cleared when you enable it again.
channel_webchat_enabledbooleanWhether the webchat widget channel is enabled. Default false.
mcp_enabledbooleanWhether the organization can be used from AI connectors through the AchieveApex MCP server. Default false.
subscription_plan_namestring | nullRead-only. Current plan. Default Free.
subscription_statusstring | nullRead-only. active, canceled, past_due, trialing, incomplete or incomplete_expired.
subscription_amountnumber | nullRead-only. Price of the plan per billing period.
billing_intervalstring | nullRead-only. day, week, month or year.
billing_interval_countnumber | nullRead-only. Number of intervals per billing period.
subscription_current_period_startstring (date-time) | nullRead-only. Start of the current billing period.
subscription_current_period_endstring (date-time) | nullRead-only. End of the current billing period.
subscription_canceled_atstring (date-time) | nullRead-only. When the subscription was canceled.
subscription_cancel_atstring (date-time) | nullRead-only. When a scheduled cancellation takes effect.
subscription_cancel_at_period_endboolean | nullRead-only. Whether the subscription ends at the end of the current period.
rate_limit_enabledbooleanRead-only. Whether API key requests are rate limited. Default true.
rate_limit_max_requestsnumber | nullRead-only. Requests allowed per window. Default 1000.
rate_limit_window_secondsnumber | nullRead-only. Rate limit window in seconds. Default 3600.
automation_limit_dailynumber | nullRead-only. Automation runs allowed per day (null = the plan default).
automation_limit_monthlynumber | nullRead-only. Automation runs allowed per month (null = the plan default).
automation_upgrade_needed_messagestring | nullRead-only. Message shown when an automation limit was reached.
automation_upgrade_needed_reasonstring | nullRead-only. daily_limit_reached, monthly_limit_reached or null.
created_by_user_idintegerRead-only. User who created the organization.
created_atstring (date-time)Read-only. Creation time.
updated_atstring (date-time)Read-only. Last update time.
deleted_atstring (date-time) | nullRead-only. Set when the organization is deleted.

Related

Report an issue with this documentation

Please log in to report issues with our documentation.