Sign in

v1

latestOpenAPI 3.1.02026-07-263911,4691.1 MB
Credentials

Lists the latest version of credentials based on applied filters.

post/credentials/v1/credentials

Request body

page_sizeinteger

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

page_tokenstring

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

sort_direction'SORT_DIRECTION_UNSPECIFIED' | 'SORT_DIRECTION_ASC' | 'SORT_DIRECTION_DESC'
document_version_sort_field'DOCUMENT_VERSION_SORT_FIELD_EXPIRY' | 'DOCUMENT_VERSION_SORT_FIELD_ISSUE_DATE' | 'DOCUMENT_VERSION_SORT_FIELD_DOCUMENT_TYPE_NAME' | 'DOCUMENT_VERSION_SORT_FIELD_MODIFIED_AT' | 'DOCUMENT_VERSION_SORT_FIELD_USER_NAME' | 'DOCUMENT_VERSION_SORT_FIELD_APPROVAL_STATUS'

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.
archived_filter'CREDENTIAL_ARCHIVED_FILTER_UNSPECIFIED' | 'CREDENTIAL_ARCHIVED_FILTER_ARCHIVED_ONLY' | 'CREDENTIAL_ARCHIVED_FILTER_ALL'

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.

Response

A successful response.

next_page_tokenstring

If there are more results available, this will be set. If this is unset, there are no more results. To get the next set of results, call GetDocuments again with page_token set to this value.

total_countinteger

The total count of credentials matching the query (filters applied) available in the current archived scope — active, archived, or all, whichever was requested.

total_archived_countinteger

The total count of archived credentials matching the same filters as this request, regardless of which archived scope was requested. Used by clients to populate a "Show archived (N)" badge without firing a second request, so the count always respects the user's active filters.