Integrations

Integrations represent built-in third-party services (identity providers, document management systems, AI providers, etc.) that can be enabled and configured per tenant. The set of available integrations is fixed — the API does not support creating or deleting integrations, only enabling/disabling them and running provider-specific authorization flows.

Integrations API

GET /api/integrations/

Retrieves the integration list.

Permissions

Requires authentication and integrations.list permission.

Request example

• Headers

Request Method: GET
Location: /api/integrations/
Authorization: JWT access_token

Response

Key	Type	Notes
limit	int
offset	int
total_count	int	Total number of integrations visible to the user (based on permissions).
filtered_count	int	Number of integrations visible to the user (based on permissions) with filters applied.
next	URL / null	Next page URL (null if there is no next page)
previous	URL / null	Previous page URL (null if there is no previous page)
results	Array	Described in the next table.

Response results array

Key	Type	Notes
uuid	uuid
name	string	Max length 255.
type	enum	One of: docu_sign, imanage, box_client_credentials, salesforce_client_credentials, microsoft_client_credentials, adobe_client_credentials, chatgpt_integration, openai_embeddings, amazon_bedrock, azure_openai, anthropic_claude.
category	enum	One of: business, ai_mcp, ai_sequencer.
description	string
is_enabled	bool	Whether the integration is enabled for the tenant. Only writable field on PATCH.
is_active	bool	Whether the integration is active (enabled and successfully authenticated/configured).
is_system	bool	Whether the integration is system-managed.
created_at	datetime
created_by	user / null	null for system-seeded records.
modified_at	datetime
modified_by	user / null
_meta.permissions	Object	Dict describing permissions.

Response example

• Status 200 OK
• Body

{
    "limit": 100,
    "offset": 0,
    "filtered_count": 1,
    "total_count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "uuid": "3b1c9a10-72e4-4c2a-9f4f-1a8f6a7d3f21",
            "name": "iManage",
            "type": "imanage",
            "category": "business",
            "description": "iManage document management integration.",
            "is_enabled": true,
            "is_active": true,
            "is_system": false,
            "created_at": "2022-08-22T09:30:04.640178+02:00",
            "created_by": {
                "id": 2,
                "first_name": "John",
                "last_name": "Smith",
                "username": "j.smith@autologyx.com",
                "company_name": "Autologyx",
                "is_deleted": false,
                "account_type": "full"
            },
            "modified_at": "2022-08-22T09:45:49.582526+02:00",
            "modified_by": {
                "id": 2,
                "first_name": "John",
                "last_name": "Smith",
                "username": "j.smith@autologyx.com",
                "company_name": "Autologyx",
                "is_deleted": false,
                "account_type": "full"
            },
            "_meta": {
                "permissions": {
                    "list": true,
                    "view": true,
                    "create": false,
                    "edit": true,
                    "delete": false
                }
            }
        }
    ]
}

Filtering

For the full description of standard predicates see ALX API standards - Developers guide.

Parameter	Predicates	Example
category	standard enum	{build}/api/integrations/?category=business

Errors

Error	Response code	Message
Requesting user is not authenticated	401 Unauthorized	"detail": "Authentication credentials were not provided."
Request from a non-allowlisted IP	403 Forbidden	"detail": "You do not have permission to perform this action."
Insufficient permissions	403 Forbidden	"detail": "You do not have permission to perform this action."
Unknown value for a filter	400 Bad Request	"category": ["Select a valid choice. {value} is not one of the available choices."]