External Integrations

List External Integrations

get

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Query parameters

searchany ofOptional

string · min: 1 · max: 200Optional

or

nullOptional

sort_byany ofOptionalDefault: -created_at

string · max: 64Optional

or

nullOptional

limitinteger · max: 100OptionalDefault: 10

continuation_tokenintegerOptionalDefault: 0

Responses

200

Successful Response

application/json

has_morebooleanRequired

continuation_tokenany ofOptional

integerOptional

or

nullOptional

totalany ofOptional

integerOptional

or

nullOptional

422

Validation Error

application/json

get

/v1/{workspace_id}/external-integrations

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/external-integrations HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "display_name": "text",
      "description": "text",
      "is_active": true,
      "created_by_entity_id": "123e4567-e89b-12d3-a456-426614174000",
      "created_by_credential_id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2026-06-06T23:15:10.294Z",
      "updated_at": "2026-06-06T23:15:10.294Z"
    }
  ],
  "has_more": true,
  "continuation_token": 1,
  "total": 1
}

Create External Integration

post

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Body

application/json

namestring · min: 2 · max: 128RequiredPattern: ^[a-z0-9][a-z0-9_-]*[a-z0-9]$

display_namestring · min: 1 · max: 256Required

descriptionany ofOptional

string · max: 4096Optional

or

nullOptional

Responses

201

Successful Response

application/json

422

Validation Error

application/json

post

/v1/{workspace_id}/external-integrations

HTTPcURLJavaScriptPython

POST /v1/{workspace_id}/external-integrations HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "name": "text",
  "display_name": "text",
  "description": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "display_name": "text",
  "description": "text",
  "is_active": true,
  "created_by_entity_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_by_credential_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-06-06T23:15:10.294Z",
  "updated_at": "2026-06-06T23:15:10.294Z"
}

Get External Integration

get

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

integration_idstring · uuidRequired

Responses

200

Successful Response

application/json

idstring · uuidRequired

workspace_idstring · uuidRequired

namestring · min: 2 · max: 128RequiredPattern: ^[a-z0-9][a-z0-9_-]*[a-z0-9]$

display_namestring · min: 1 · max: 256Required

descriptionany ofOptional

string · max: 4096Optional

or

nullOptional

is_activebooleanRequired

created_by_entity_idstring · uuidRequired

created_by_credential_idany ofOptional

string · uuidOptional

or

nullOptional

created_atany ofOptional

string · date-timeOptional

or

nullOptional

updated_atany ofOptional

string · date-timeOptional

or

nullOptional

422

Validation Error

application/json

get

/v1/{workspace_id}/external-integrations/{integration_id}

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/external-integrations/{integration_id} HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "display_name": "text",
  "description": "text",
  "is_active": true,
  "created_by_entity_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_by_credential_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-06-06T23:15:10.294Z",
  "updated_at": "2026-06-06T23:15:10.294Z"
}

Delete external integration

delete

Soft-deletes an active external integration by marking it inactive, then revokes any active client credentials for that integration in the same workspace-scoped transaction. Requires an admin or owner role with ExternalIntegration.delete and ApiKey.delete permissions.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

integration_idstring · uuidRequired

Responses

204

Successful Response

422

Validation Error

application/json

delete

/v1/{workspace_id}/external-integrations/{integration_id}

HTTPcURLJavaScriptPython

DELETE /v1/{workspace_id}/external-integrations/{integration_id} HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update external integration

patch

Updates external integration metadata. Supports partial updates for name, display_name, and description; pass description: null to clear the description. Requires an admin or owner role with ExternalIntegration.update permission.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

integration_idstring · uuidRequired

Body

application/json

namestring · min: 2 · max: 128OptionalPattern: ^[a-z0-9][a-z0-9_-]*[a-z0-9]$

display_namestring · min: 1 · max: 256Optional

descriptionany ofOptional

string · max: 4096Optional

or

nullOptional

Responses

200

Successful Response

application/json

idstring · uuidRequired

workspace_idstring · uuidRequired

namestring · min: 2 · max: 128RequiredPattern: ^[a-z0-9][a-z0-9_-]*[a-z0-9]$

display_namestring · min: 1 · max: 256Required

descriptionany ofOptional

string · max: 4096Optional

or

nullOptional

is_activebooleanRequired

created_by_entity_idstring · uuidRequired

created_by_credential_idany ofOptional

string · uuidOptional

or

nullOptional

created_atany ofOptional

string · date-timeOptional

or

nullOptional

updated_atany ofOptional

string · date-timeOptional

or

nullOptional

422

Validation Error

application/json

patch

/v1/{workspace_id}/external-integrations/{integration_id}

HTTPcURLJavaScriptPython

PATCH /v1/{workspace_id}/external-integrations/{integration_id} HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "name": "text",
  "display_name": "text",
  "description": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "display_name": "text",
  "description": "text",
  "is_active": true,
  "created_by_entity_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_by_credential_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-06-06T23:15:10.294Z",
  "updated_at": "2026-06-06T23:15:10.294Z"
}

List External Integration Credentials

get

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

integration_idstring · uuidRequired

Responses

200

Successful Response

application/json

idstring · uuidRequired

workspace_idstring · uuidRequired

integration_idstring · uuidRequired

client_idstringRequired

service_idsstring · uuid[]Required

nameany ofOptional

stringOptional

or

nullOptional

is_activebooleanRequired

expires_atany ofOptional

string · date-timeOptional

or

nullOptional

created_atany ofOptional

string · date-timeOptional

or

nullOptional

updated_atany ofOptional

string · date-timeOptional

or

nullOptional

rotated_atany ofOptional

string · date-timeOptional

or

nullOptional

revoked_atany ofOptional

string · date-timeOptional

or

nullOptional

422

Validation Error

application/json

get

/v1/{workspace_id}/external-integrations/{integration_id}/credentials

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/external-integrations/{integration_id}/credentials HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
    "integration_id": "123e4567-e89b-12d3-a456-426614174000",
    "client_id": "text",
    "service_ids": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "name": "text",
    "is_active": true,
    "expires_at": "2026-06-06T23:15:10.294Z",
    "created_at": "2026-06-06T23:15:10.294Z",
    "updated_at": "2026-06-06T23:15:10.294Z",
    "rotated_at": "2026-06-06T23:15:10.294Z",
    "revoked_at": "2026-06-06T23:15:10.294Z"
  }
]

Create External Integration Credential

post

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

integration_idstring · uuidRequired

Body

application/json

service_idsstring · uuid[] · min: 1 · max: 100Required

nameany ofOptional

string · min: 1 · max: 256Optional

or

nullOptional

expires_atany ofOptional

string · date-timeOptional

or

nullOptional

Responses

201

Successful Response

application/json

422

Validation Error

application/json

post

/v1/{workspace_id}/external-integrations/{integration_id}/credentials

HTTPcURLJavaScriptPython

POST /v1/{workspace_id}/external-integrations/{integration_id}/credentials HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 110

{
  "service_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "name": "text",
  "expires_at": "2026-06-06T23:15:10.294Z"
}

{
  "credential": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
    "integration_id": "123e4567-e89b-12d3-a456-426614174000",
    "client_id": "text",
    "service_ids": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "name": "text",
    "is_active": true,
    "expires_at": "2026-06-06T23:15:10.294Z",
    "created_at": "2026-06-06T23:15:10.294Z",
    "updated_at": "2026-06-06T23:15:10.294Z",
    "rotated_at": "2026-06-06T23:15:10.294Z",
    "revoked_at": "2026-06-06T23:15:10.294Z"
  },
  "client_secret": "text"
}

Rotate External Integration Credential

post

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

integration_idstring · uuidRequired

credential_idstring · uuidRequired

Responses

200

Successful Response

application/json

client_secretstringRequired

422

Validation Error

application/json

post

/v1/{workspace_id}/external-integrations/{integration_id}/credentials/{credential_id}/rotate

HTTPcURLJavaScriptPython

POST /v1/{workspace_id}/external-integrations/{integration_id}/credentials/{credential_id}/rotate HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "credential": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
    "integration_id": "123e4567-e89b-12d3-a456-426614174000",
    "client_id": "text",
    "service_ids": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "name": "text",
    "is_active": true,
    "expires_at": "2026-06-06T23:15:10.294Z",
    "created_at": "2026-06-06T23:15:10.294Z",
    "updated_at": "2026-06-06T23:15:10.294Z",
    "rotated_at": "2026-06-06T23:15:10.294Z",
    "revoked_at": "2026-06-06T23:15:10.294Z"
  },
  "client_secret": "text"
}

Revoke External Integration Credential

delete

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

integration_idstring · uuidRequired

credential_idstring · uuidRequired

Responses

204

Successful Response

422

Validation Error

application/json

delete

/v1/{workspace_id}/external-integrations/{integration_id}/credentials/{credential_id}

HTTPcURLJavaScriptPython

DELETE /v1/{workspace_id}/external-integrations/{integration_id}/credentials/{credential_id} HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content