The organization object

A comprehensive list of the organization resource's attributes and relationships

An organization object is returned as part of the response body of each successful create, list, retrieve or update API call to the /api/organizations endpoint.

Fields

Field	Type	Description
type	string	organizations
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.config	object	The organization's configuration.
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. Format is HEX (starts with # and it's followed by six letters and/or numbers).
attributes.contrast_color	string	The organization's contrast color. Format is HEX (starts with # and it's followed by six letters and/or numbers).
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.discount_disabled	boolean	Indicates if organization has discount disabled.
attributes.account_disabled	boolean	Indicates if organization has account disabled.
attributes.acceptance_disabled	boolean	Indicates if organization has acceptance disabled.
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.region	string	The region where the organization it's located, default value it's eu-west-1.
attributes.can_switch_live	boolean	Indicates if the organization can switch to live mode.
attributes.subscription_info	object	Information about the current subscription such as the plan type, limits and subscription totals counter.
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.
relationships.memberships	array	The memberships associated to the organization.
relationships.roles	array	The roles associated to the organization.
relationships.permissions	array	The permissions associated to the organization.
relationships.api_credentials	array	The API credentials associated to the organization.