API

Lists the latest version of credentials based on applied filters.

post
https://api.safetyculture.io/credentials/v1/credentials
Body Params
int32

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

string

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

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
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:
Responses

Updated 12 days ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 12 days ago