List integrated accounts

Integrated accounts are created when a customer connects an app with Truto. You can use this endpoint to list all the integrated accounts that have been created for your Truto account.

Integrated accounts for a specific customer

You can filter the integrated accounts by specifying the tenant_id attribute in the query string. This is useful when you want to look up an integrated account for a specific customer.

Endpoint

http

GET /integrated-account

Query parameters

Refer Specifying query parameters in Truto APIs

tenant_id

string

The ID of the tenant you want to filter the integrated accounts by.

Example: acme-1

is_sandbox

boolean

Whether the integrated account is in sandbox mode or not. Sandbox integrated accounts do not allow any "write" operations.

integration.name

string

The name of the integration you want to filter the integrated accounts by.

Example: zendesk

features.super_query

string

Filter the integrated accounts by the ones using SuperQuery. The value will be the SuperQuery region.

All possible enum values:

apac
wnam

Example: apac

status

string

Filter the integrated accounts by status.

All possible enum values:

active
connecting
post_install_error
validation_error
needs_reauth

Example: active

created_at

string · date-time

Filter the integrated accounts by the date and time when they were created.

Example: 2021-08-10T10:00:00.000Z

updated_at

string · date-time

Filter the integrated accounts by the date and time when they were last updated.

Example: 2021-08-10T10:00:00.000Z

Response Body

results

object[]

string · uuid

The ID of the integrated account.

Example: 1ba1f401-7183-47c5-9e39-e8e257e3c795

tenant_id

string

The ID of the tenant.

Example: acme-1

environment_integration_id

string

The ID of the environment integration (installed integration).

Example: b179ad55-db02-4bd4-b7a4-d2c173eee9ae

context

object

The context of the integrated account. You can find these in the Variables section of an integrated account in the Truto UI.

Example:

{
  "zendesk_subdomain": "truto"
}

status

string

Status of the integrated account.

active - Everything is fine and the account should work
connecting - Post install and validation steps are being run
post_install_error - There was an error while running post install steps
validation_error - There was an error while running validation steps
needs_reauth - There was an error while refreshing the credentials in case of OAuth authentication or the credentials are no longer valid in other authentication methods. The integrated account needs to be reauthorized.

All possible enum values:

active
connecting
post_install_error
validation_error
needs_reauth

last_error

string

The last error that occurred while running the post install or validation steps.

last_action_result

object

The results of the post install and validation steps that ran on the integrated account.

created_at

string · date-time

The date and time when the integrated account was created.

Example: 2021-08-10T10:00:00.000Z

updated_at

string · date-time

The date and time when the integrated account was last updated.

Example: 2021-08-10T10:00:00.000Z

is_sandbox

boolean

Whether the integrated account is in sandbox mode or not. Sandbox integrated accounts do not allow any "write" operations.

authentication_method

string

Type of authentication used.

All possible enum values:

oauth2
api_key
oauth2_client_credentials
keka_oauth

environment_id

string · uuid

The ID of the environment this integrated account belongs to.

Example: 8a2b104d-74a6-47f2-b93e-c6b611e82391

integration

object

The integration associated with this integrated account.

string · uuid

The ID of the integration.

Example: 4a4de828-f4db-4c9e-adfd-434e0864c3c7

name

string

The name of the integration.

Example: zendesk

category

string

The category of the integration.

Example: helpdesk

is_beta

boolean

Whether the integration is in beta or not. Beta integrations might not have been tested completely and are not recommended for production environments.

config

object

The configuration object defining the underlying API of the integration.

Example:

{
  "base_url": "https://api.example.com",
  "label": "Example API Integration",
  "logo": "https://example.com/logo.png",
  "icon": "https://example.com/icon.png",
  "headers": {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "User-Agent": "truto"
  },
  "query": {
    "search": "{{search_query}}",
    "filter": "{{filter_criteria}}"
  },
  "query_array_format": "comma",
  "actions": {
    "sync_users": {
      "type": "request",
      "config": {
        "method": "post",
        "path": "/sync/users",
        "headers": {
          "Authorization": "Bearer {{oauth.token.access_token}}"
        },
        "body": {
          "users": "{{context.users}}"
        }
      }
    }
  },
  "credentials": {
    "oauth2": {
      "format": "oauth2",
      "config": {
        "client": {
          "id": "your-client-id",
          "secret": "your-client-secret"
        },
        "auth": {
          "tokenHost": "https://auth.example.com",
          "tokenPath": "/oauth/token",
          "refreshPath": "/oauth/refresh"
        },
        "options": {
          "scopeSeparator": " ",
          "authorizationMethod": "header",
          "bodyFormat": "form"
        },
        "fields": [
          {
            "name": "client_id",
            "label": "Client ID",
            "type": "text",
            "required": true
          },
          {
            "name": "client_secret",
            "label": "Client Secret",
            "type": "password",
            "required": true
          }
        ],
        "tokenParams": {
          "grant_type": "client_credentials"
        },
        "refreshParams": {
          "grant_type": "refresh_token"
        },
        "tokenExpiryDuration": "3600"
      }
    }
  },
  "authorization": {
    "format": "bearer",
    "config": {
      "token": "{{oauth.token.access_token}}"
    }
  },
  "pagination": {
    "format": "page",
    "config": {
      "page_key": "page",
      "limit_key": "per_page"
    }
  },
  "rate_limit": {
    "is_rate_limited": true,
    "retry_after_header_expression": "Retry-After",
    "rate_limit_header_expression": "X-RateLimit-Remaining"
  },
  "resources": {
    "users": {
      "list": {
        "method": "get",
        "path": "/users",
        "response_path": "data.users",
        "headers": {
          "Authorization": "Bearer {{oauth.token.access_token}}"
        },
        "query": {
          "page": "{{pagination.page}}",
          "per_page": "{{pagination.per_page}}"
        },
        "pagination": {
          "format": "page",
          "config": {
            "page_key": "page",
            "limit_key": "per_page"
          }
        },
        "authorization": {
          "format": "bearer",
          "config": {
            "token": "{{oauth.token.access_token}}"
          }
        },
        "rate_limit": {
          "is_rate_limited": true,
          "retry_after_header_expression": "Retry-After",
          "rate_limit_header_expression": "X-RateLimit-Remaining"
        },
        "examples": {
          "response": "{\n  \"data\": {\n    \"users\": [\n      {\n        \"id\": \"123e4567-e89b-12d3-a456-426614174000\",\n        \"name\": \"John Doe\",\n        \"email\": \"john.doe@example.com\"\n      }\n    ]\n  }\n}\n"
        }
      }
    },
    "orders": {
      "create": {
        "method": "post",
        "path": "/orders",
        "body": {
          "user_id": "{{context.user_id}}",
          "items": "{{context.items}}"
        },
        "response_path": "data.order",
        "headers": {
          "Authorization": "Bearer {{oauth.token.access_token}}"
        },
        "authorization": {
          "format": "bearer",
          "config": {
            "token": "{{oauth.token.access_token}}"
          }
        }
      }
    }
  },
  "webhook": {
    "signature_verification": {
      "format": "HMAC-SHA256",
      "config": {
        "secret": "your-webhook-secret",
        "algorithm": "sha256",
        "parts": [
          "header",
          "body"
        ]
      }
    },
    "handle_verification": "verify_webhook_signature"
  },
  "error_expression": "{{response.error}}"
}

team_id

string · uuid

The ID of the team that owns this integration.

Example: 05daecaf-4365-42e8-8370-8127de5dd717

sharing

string

The sharing policy of the integration.

All possible enum values:

allow
ask
deny

Example: allow

created_at

string · date-time

The date and time when the integration was created.

Example: 2021-08-10T10:00:00.000Z

updated_at

string · date-time

The date and time when the integration was last updated.

Example: 2021-08-10T10:00:00.000Z

object_store_context_fields

string[]

The list of context fields that are stored in the object store.

next_cursor

string

limit

number