Lists the latest version of credentials based on applied filters.

post

https://api.safetyculture.io/credentials/v1/credentials

Body Params

page_size

int32

The number of credentials to return in a single request. This defaults to 20.

page_token

string

If present, will fetch the next page of results. This must be the value of next_page_token from the response.

sort_direction

string

enum

Defaults to SORT_DIRECTION_UNSPECIFIED

The direction to sort credentials in.

Allowed:

document_version_filters

array of objects

An array of filters that can be provided to request specific credentials.

document_version_filters

document_version_sort_field

string

enum

DocumentVersionSortField is used to sort document versions based on various criteria.

DOCUMENT_VERSION_SORT_FIELD_EXPIRY: DOCUMENT_VERSION_SORT_FIELD_EXPIRY will sort credentials by expiry date.
DOCUMENT_VERSION_SORT_FIELD_ISSUE_DATE: DOCUMENT_VERSION_SORT_FIELD_ISSUE_DATE will sort credentials by issue date.
DOCUMENT_VERSION_SORT_FIELD_DOCUMENT_TYPE_NAME: DOCUMENT_VERSION_SORT_FIELD_DOCUMENT_TYPE_NAME will sort credentials by document type name.
DOCUMENT_VERSION_SORT_FIELD_MODIFIED_AT: DOCUMENT_VERSION_SORT_FIELD_MODIFIED_AT will sort credentials by modified at date.
DOCUMENT_VERSION_SORT_FIELD_USER_NAME: DOCUMENT_VERSION_SORT_FIELD_USER_NAME will sort credentials by user name.
DOCUMENT_VERSION_SORT_FIELD_APPROVAL_STATUS: DOCUMENT_VERSION_SORT_FIELD_APPROVAL_STATUS will sort credentials by approval status.

Allowed:

archived_filter

string

enum

Defaults to CREDENTIAL_ARCHIVED_FILTER_UNSPECIFIED

CredentialArchivedFilter controls which credentials are returned based on their archived status.

CREDENTIAL_ARCHIVED_FILTER_UNSPECIFIED: CREDENTIAL_ARCHIVED_FILTER_UNSPECIFIED returns only unarchived credentials. This is the default behavior.
CREDENTIAL_ARCHIVED_FILTER_ARCHIVED_ONLY: CREDENTIAL_ARCHIVED_FILTER_ARCHIVED_ONLY returns only archived credentials.
CREDENTIAL_ARCHIVED_FILTER_ALL: CREDENTIAL_ARCHIVED_FILTER_ALL returns both archived and unarchived credentials.

Allowed:

Responses

200A successful response.