Sign in

v1

latestOpenAPI 3.0.12026-07-226992320.0 KB
Integration Auth

List Integration Auth

Returns a paginated list of auth records for a given integration, sorted by most recently created first. Use the authType parameter to filter by credential type. Use page and size to navigate through results.

get/v1/integrations/{integrationId}/auth

Path parameters

integrationIdstring required

Unique identifier for the integration

Query parameters

authTypestring

Filter auth records by credential type. Accepted values: 'API_KEY', 'BASIC', 'BEARER'. Omit to return auth records of all types.

pageinteger

Zero-based page number to retrieve. Use 0 for the first page. Must be 0 or greater.

sizeinteger

Number of auth records to return per page. Must be 1 or greater. Defaults to 10.

Response

OK

pageinteger

Current page number (0-based index). Indicates which page of results is being returned.

sizeinteger

Number of items requested per page. Determines the maximum size of the 'data' list.

totalCountinteger

Total number of records available across all pages. Useful for calculating pagination on the client side.

totalPagesinteger

Total number of pages available based on totalCounts and size. Helps clients understand how many pages exist in total.

hasNextboolean

Indicates whether there is a next page available after the current one. Useful for implementing 'Load More' or next navigation.

hasPreviousboolean

Indicates whether there is a previous page before the current one. Useful for enabling backward navigation.

Example response

{
  "data": [
    {
      "authId": "auth_P3kNz7Yv1Qm9",
      "integrationId": "intg_AuUKK371Spr5",
      "authType": "API_KEY"
    }
  ],
  "size": 20,
  "totalCount": 125,
  "totalPages": 7,
  "hasNext": true
}