Integrations / List
Returns all integrations
Route: /api/{tenant:minlength(2)}/v{version:apiVersion}/integrations
Method: GET
Authorisation: Minimum role: ADMIN
Request Arguments
| Name | Type | Source |
|---|
Request body example
Response object
Response status: 200 (OK)
Response type: DTO_integration[]
Wrapper: DTO_response_wrap
Other response statuses: 400 (BadRequest), 403 (Forbidden)
Response body example
DTO_integration
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| oauth2 | DTO_external_auth_oauth2 | Oauth2 | |
| shopify | DTO_integration_shopify | ReadOnly | Shopify specific data |
| created_by | DTO_reference_user | ReadOnly | Created by |
| last_updated_by | DTO_reference_user | ReadOnly | Last updated by |
| id | Int32 | Id | |
| type | ENUM integration_type | Type | |
| created | DateTime | ReadOnly | Created |
| last_updated | DateTime | ReadOnly | Last updated |
DTO_external_auth_oauth2
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| identifier | String | Identifier | |
| authorized_account | String | ReadOnly | Authorized account |
DTO_integration_shopify
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| shop_domain | String | Shop domain |
DTO_reference_user
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| profile_pic | String | ReadOnly | Profile pic |
| String | ReadOnly | ||
| id | Int32 | Id | |
| label | Object | ReadOnly | Label |
ENUM integration_type
| Value | Name | Description |
|---|---|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | SHOPIFY | Shopify |
