Skip to main content
GET
Permission Required: project:view-configs
Retrieve a paginated list of credential kinds for your project. The returned id matches the credential_kind_id field on test player credentials, so this endpoint is useful when constructing tests that reference credentials.

Query Parameters

integer
default:"0"
Page number (0-indexed)
integer
default:"25"
Results per page (1-100)

Response

CredentialKind[]
required
Array of credential kind objects
object
required
Pagination metadata (page, page_size, total_count, total_pages)

CredentialKind Object

string
required
Credential kind ID (use as credential_kind_id on test player credentials)
string
required
Credential kind name
string
Optional description
boolean
required
Whether each credential of this kind can be used by at most one concurrent run

Authorizations

X-Api-Key
string
header
required

API key for authentication

Path Parameters

projectId
string
required

The project ID. You can copy it from the project settings page or the project URL in the dashboard.

Query Parameters

page
integer
default:0

Page number (0-indexed)

page_size
integer
default:25

Results per page (1-100)

Required range: 1 <= x <= 100

Response

Successful response

data
object[]
pagination
object