API documentation | API docs for agents | OpenAPI 3.1

GET /api/v1/organization/settings

ark.get_organization_settings

Gets tenant-admin organization settings and operational toggles. Sensitive payment credentials are always masked on the external API.

Availability
Expanded preview
Scopes
admin:read
ARK permissions
None
Team visibility
Not entity-scoped
Idempotency-Key
Not required
Approval
No MCP approval on REST API-token calls
Rate limit
API credential and organization budgets

Parameters

None.

Request body

None.

Example request

Shell
curl 'https://arktms.com/api/v1/organization/settings' \
  -H "Authorization: Bearer $ARK_API_TOKEN"

Success response

Organization settings

objectstringrequired

one of: api_response

okbooleanrequired

one of: true

api_versionstringrequired

one of: 2026-05-31

request_idstringrequired
dataobjectrequired
data.idstringrequired

format: uuid

data.namestringrequired
data.mcNumberstring | nullrequired
data.dotNumberstring | nullrequired
data.invoiceContactstring | nullrequired
data.invoiceInstructionsstring | nullrequired
data.rateconTermsstring | nullrequired
data.subscriptionStatusstring | nullrequired
data.maxUsersinteger | nullrequired

Errors

HTTP 400
Invalid request
HTTP 401
Authentication required
HTTP 403
Permission, scope, team, or entitlement denied
HTTP 404
Resource not found