Skip to main content

integrations

Get all integrations for a brand

integrations(
  after: String
  before: String
  brandId: ID
  companyId: ID
  filters: IntegrationFilterInput
  first: Int
  integrationType: IntegrationTypeEnum
  last: Int
  sortField: IntegrationSortFieldEnum = CREATED_AT
  sortType: SortTypeEnum = DESC
): IntegrationConnection!

Arguments​

integrations.after ● String scalar​

Returns the elements in the list that come after the specified cursor.

integrations.before ● String scalar​

Returns the elements in the list that come before the specified cursor.

integrations.brandId ● ID deprecated scalar​

DEPRECATED

Use filters.brand_ids instead.

The brand ID to get integrations for. If not provided, will use the current brand from X-Brand-Id header. If no header is provided, will use only the current company to filter integrations. The user must have permissions to access the brand and company and list the integrations.

Take into account the next behaviors:

* If the brand_id is provided, the user must have permissions to access the brand, which means having a role authorized in the brand. * If the brand_id is not provided, the user must have permissions to access the company, which means having a role authorized to read the integrations in the company.

integrations.companyId ● ID deprecated scalar​

DEPRECATED

No longer needed.

The company ID to get integrations for. If not provided, will use the current company from X-Company-Id header. If no header is provided, will use only the current brand to filter integrations. The user must have permissions to access the company and list the integrations.

integrations.filters ● IntegrationFilterInput input​

Filtering options for integrations.

integrations.first ● Int scalar​

Returns the first _n_ elements from the list.

integrations.integrationType ● IntegrationTypeEnum deprecated enum​

DEPRECATED

Use filters.integration_type instead.

The integration type to filter the results.

integrations.last ● Int scalar​

Returns the last _n_ elements from the list.

integrations.sortField ● IntegrationSortFieldEnum deprecated enum​

DEPRECATED

Use filters.sort_field instead.

The sort field to use for the results.

integrations.sortType ● SortTypeEnum deprecated enum​

DEPRECATED

Use filters.sort_type instead.

The sort type to use for the results.

Type​

IntegrationConnection object​

The connection type for Integration.