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

FieldTypeDescription

type

string

organization

id

string

The organization unique identifier

links.self

string

The organization endpoint URL

attributes.name

string

The organization's internal name.

attributes.slug

string

The organization's slug name.

attributes.domain

string

The organization's domain.

attributes.support_phone

string

The organization's support phone.

attributes.support_email

string

The organization's support email.

attributes.logo_url

string

The URL to the organization's logo.

attributes.favicon_url

string

The URL to the organization's favicon.

attributes.primary_color

string

The organization's primary color.

attributes.gtm_id

string

The organization's Google Tag Manager ID.

attributes.gtm_id_test

string

The organization's Google Tag Manager ID for test.

attributes.max_concurrent_promotions

integer

The maximum number of active concurrent promotions allowed for your organization.

attributes.max_concurrent_imports

integer

The maximum number of concurrent imports allowed for your organization.

attributes.max_concurrent_exports

integer

The maximum number of concurrent exports allowed for your organization.

attributes.max_concurrent_cleanups

integer

The maximum number of concurrent cleanups allowed for your organization.

attributes.order_number_editable_test

boolean

Enables orders number editing as a string in test (for enterprise plans only).

attributes.order_number_editable_live

boolean

Enables orders number editing as a string in live (for enterprise plans only).

attributes.config

object

The organization's configuration.

attributes.created_at

datetime

Time at which the resource was created.

attributes.updated_at

datetime

Time at which the resource was last updated.

attributes.reference

string

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

string

Any identifier of the third party system that defines the reference code

attributes.metadata

object

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

string

The resource environment (can be one of test or live)

Last updated