The organization object
A comprehensive list of the organization resource's attributes and relationships
The organization object is returned as part of the response body of each successful retrieve API call to the /api/organization
endpoint.
Fields
Field | Type | Description |
---|---|---|
type |
|
|
id |
| The organization unique identifier |
links.self |
| The organization endpoint URL |
attributes.name |
| The organization's internal name. |
attributes.slug |
| The organization's slug name. |
attributes.domain |
| The organization's domain. |
attributes.support_phone |
| The organization's support phone. |
attributes.support_email |
| The organization's support email. |
attributes.logo_url |
| The URL to the organization's logo. |
attributes.favicon_url |
| The URL to the organization's favicon. |
attributes.primary_color |
| The organization's primary color. |
attributes.gtm_id |
| The organization's Google Tag Manager ID. |
attributes.gtm_id_test |
| The organization's Google Tag Manager ID for test. |
attributes.max_concurrent_promotions |
| The maximum number of active concurrent promotions allowed for your organization. |
attributes.max_concurrent_imports |
| The maximum number of concurrent imports allowed for your organization. |
attributes.max_concurrent_exports |
| The maximum number of concurrent exports allowed for your organization. |
attributes.max_concurrent_cleanups |
| The maximum number of concurrent cleanups allowed for your organization. |
attributes.order_number_editable_test |
| Enables orders number editing as a string in test (for enterprise plans only). |
attributes.order_number_editable_live |
| Enables orders number editing as a string in live (for enterprise plans only). |
attributes.config |
| The organization's configuration. |
attributes.created_at |
| Time at which the resource was created. |
attributes.updated_at |
| Time at which the resource was last updated. |
attributes.reference |
| A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. |
attributes.reference_origin |
| Any identifier of the third party system that defines the reference code |
attributes.metadata |
| Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. |
meta.mode |
| The resource environment (can be one of |
Last updated