Integrations
List integrations
Scope: integration:read
Authorization
bearerAuth An API key, or an access token minted from one. Pass it in the Authorization header: Bearer admp_...
In: header
Query Parameters
Filter expression to narrow results. Uses the Admiral filter DSL.
Filterable fields:
name: filter by integration name.kind: filter by kind.status: filter by status.
Example: field['kind'] = 'KIND_GITHUB' AND field['status'] = 'STATUS_CONNECTED'
length <= 1024The page_size query parameter.
int320 <= value <= 100The page_token query parameter.
Response Body
application/json
curl -X GET "https://example.com/v1/integrations"{ "integrations": [ { "id": "string", "name": "string", "kind": "KIND_UNSPECIFIED", "status": "STATUS_UNSPECIFIED", "status_reason": "string", "settings": { "github": { "installation_id": "string", "account_login": "string", "account_type": "ACCOUNT_TYPE_UNSPECIFIED", "repository_selection": "REPOSITORY_SELECTION_UNSPECIFIED", "repositories": [ "string" ], "url": "string", "suspended_at": "2023-01-15T01:30:15.01Z" } }, "created_by": { "id": "string", "display_name": "string", "email": "string" }, "created_at": "2023-01-15T01:30:15.01Z", "updated_at": "2023-01-15T01:30:15.01Z" } ], "next_page_token": "string"}Start installing an app POST
For KIND_GITHUB the person must be an owner of the GitHub organization, since GitHub lets only an owner install an app that asks for organization permissions. Scope: `integration:write`
Invite someone into the current organization POST
A live invitation for the same address is retired and replaced, so a retry or a "send it again" is this same call. ALREADY_EXISTS when the address is already a member. INVALID_ARGUMENT for OWNER, which moves by transfer, never by invitation. Scope: `user:write`