List credential types
Returns a paginated list of credential types configured for the authenticated user's account.
Credential types define the formats and types of credentials (cards, PINs, mobile access, etc.) that can be used.
Each credential type is based on a global credential type and can be customized per account.
/api/3/credential_types
Authentication
This endpoint requires authentication:
Use an OAuth 2.0 access token in the Authorization header. This is the recommended authentication method for all integrations. OAuth provides automatic token expiration, granular permission scopes, detailed usage tracking, and per-integration revocation. Learn how to obtain an access token.
Header Format:
Authorization: Bearer YOUR_ACCESS_TOKEN
Required Scopes:
account.credential_type.readonly
Parameters
Query Parameters
per_page
integer
Number of results per page
Default: 500
page
integer
Page number for pagination
Default: 1
skip_pagination
boolean
Skip pagination and return all results
Responses
List of credential types retrieved successfully
Response Fields
id
integer
required
Unique identifier for the credential type
eg. 5
label
string
required
Human-readable label for the credential type (must be unique within account)
eg. Employee Card
slug
string
required
URL-friendly identifier used in API requests (must be unique within account, auto-parameterized)
eg. employee_card
code
integer | null
required
Numeric code from the associated global credential type
eg. 100
Unauthorized - Invalid or missing authentication
Response Fields
error
string
eg. unauthorized
error_description
string
eg. The access token is invalid
Forbidden - User does not have permission
Response Fields
error
string
eg. forbidden
error_description
string
eg. You are not authorized to access this resource
Internal Server Error
Response Fields
error
string
eg. internal_server_error
error_description
string
eg. An unexpected error occurred
Mentioned in Guides
This endpoint is used in the following guides: