Ctrlk
Go to website
For the complete documentation index, see llms.txt. This page is also available as Markdown.

External Integrations

List External Integrations

get
Authorizations
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
sort_bystring[]OptionalDefault: []
limitinteger · max: 200OptionalDefault: 50
continuation_tokenanyOptional
searchstring · min: 1 · max: 200 · nullableOptional
Responses
200

Successful Response

application/json
has_morebooleanRequired
continuation_tokenanyOptional
get/v1/{workspace_id}/external-integrations
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-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ],
  "has_more": true,
  "continuation_token": null
}

Create External Integration

post
Authorizations
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
namestring · min: 2 · max: 128RequiredPattern: ^[a-z0-9][a-z0-9_-]*[a-z0-9]$
display_namestring · min: 1 · max: 256Required
descriptionstring · max: 4096 · nullableOptional
Responses
201

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
descriptionstring · max: 4096 · nullableOptional
is_activebooleanRequired
created_by_entity_idstring · uuidRequired
created_by_credential_idstring · uuid · nullableOptional
created_atstring · date-time · nullableOptional
updated_atstring · date-time · nullableOptional
post/v1/{workspace_id}/external-integrations
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-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Get External Integration

get
Authorizations
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
descriptionstring · max: 4096 · nullableOptional
is_activebooleanRequired
created_by_entity_idstring · uuidRequired
created_by_credential_idstring · uuid · nullableOptional
created_atstring · date-time · nullableOptional
updated_atstring · date-time · nullableOptional
get/v1/{workspace_id}/external-integrations/{integration_id}
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-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

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
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

No content
delete/v1/{workspace_id}/external-integrations/{integration_id}
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
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
namestring · min: 2 · max: 128OptionalPattern: ^[a-z0-9][a-z0-9_-]*[a-z0-9]$
display_namestring · min: 1 · max: 256Optional
descriptionstring · max: 4096 · nullableOptional
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
descriptionstring · max: 4096 · nullableOptional
is_activebooleanRequired
created_by_entity_idstring · uuidRequired
created_by_credential_idstring · uuid · nullableOptional
created_atstring · date-time · nullableOptional
updated_atstring · date-time · nullableOptional
patch/v1/{workspace_id}/external-integrations/{integration_id}
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-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

List External Integration Credentials

get
Authorizations
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
namestring · nullableOptional
is_activebooleanRequired
expires_atstring · date-time · nullableOptional
created_atstring · date-time · nullableOptional
updated_atstring · date-time · nullableOptional
rotated_atstring · date-time · nullableOptional
revoked_atstring · date-time · nullableOptional
get/v1/{workspace_id}/external-integrations/{integration_id}/credentials
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-01-01T00:00:00.000Z",
    "created_at": "2026-01-01T00:00:00.000Z",
    "updated_at": "2026-01-01T00:00:00.000Z",
    "rotated_at": "2026-01-01T00:00:00.000Z",
    "revoked_at": "2026-01-01T00:00:00.000Z"
  }
]

Create External Integration Credential

post
Authorizations
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
service_idsstring · uuid[] · min: 1 · max: 100Required
namestring · min: 1 · max: 256 · nullableOptional
expires_atstring · date-time · nullableOptional
Responses
201

Successful Response

application/json
client_secretstringRequired
post/v1/{workspace_id}/external-integrations/{integration_id}/credentials
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-01-01T00:00:00.000Z"
}
{
  "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-01-01T00:00:00.000Z",
    "created_at": "2026-01-01T00:00:00.000Z",
    "updated_at": "2026-01-01T00:00:00.000Z",
    "rotated_at": "2026-01-01T00:00:00.000Z",
    "revoked_at": "2026-01-01T00:00:00.000Z"
  },
  "client_secret": "text"
}

Rotate External Integration Credential

post
Authorizations
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
post/v1/{workspace_id}/external-integrations/{integration_id}/credentials/{credential_id}/rotate
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-01-01T00:00:00.000Z",
    "created_at": "2026-01-01T00:00:00.000Z",
    "updated_at": "2026-01-01T00:00:00.000Z",
    "rotated_at": "2026-01-01T00:00:00.000Z",
    "revoked_at": "2026-01-01T00:00:00.000Z"
  },
  "client_secret": "text"
}

Revoke External Integration Credential

delete
Authorizations
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

No content
delete/v1/{workspace_id}/external-integrations/{integration_id}/credentials/{credential_id}
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
PreviousIntegrations
NextConversations

Last updated

Was this helpful?