Sign in
Integrations key

List integration keys

Returns a paginated list of the caller's integration keys (stored third-party credentials). Keys are scoped to the authenticated user (Cardda staff see all).

The secret fields password and token are never returned. Each key includes company_ids, the companies managed with it.

Supports _start/_end pagination, _field/_order sorting, and per-field filters.

get/v1/integrations/keys

Query parameters

key_service_idstring

Filter by integration service id.

enabledboolean

Filter by whether the key is enabled.

Parameters

#/paths/~1v1~1bills/get/parameters/0 — unresolved $ref
#/paths/~1v1~1bills/get/parameters/1 — unresolved $ref
#/paths/~1v1~1bills/get/parameters/2 — unresolved $ref
#/paths/~1v1~1bills/get/parameters/3 — unresolved $ref
#/paths/~1v1~1bills/get/parameters/4 — unresolved $ref

Response

Paginated list of integration keys.

idstring uuid required
statusstring required
enabledboolean nullable
auth_method'token' | 'password' required

Authentication method, inherited from the key service.

identifierstring nullable

The account identifier (e.g. RUT/username) for password-based services.

identifier_typestring nullable
key_service_idstring required

Id of the integration service this key authenticates against.

user_idstring required

Owner of the key.

company_idsstring[]

Ids of the companies managed with this key, added via serializer method.

metaobject nullable
created_atstring date-time
updated_atstring date-time

Example response

[
  {
    "status": "active",
    "auth_method": "password"
  }
]

Changes