Credentials

Search for Credentials (v1)

DEPRECATED: This is a deprecated API. Please consider switching to the updated v2 Search API for better performance and support.

Rate Limiting: For this deprecated endpoint, there is a strict rate limit of 100 requests per 60 seconds, per IP address.

post/v1/credentials/search

Request body

group_idstring

Limit the returned Credentials to a specific group ID.

recipient.namestring

Limit the returned Credentials to a recipient's name

recipient.emailstring

Limit the returned Credentials to a specific recipient's email address.

recipient.idstring

Limit the returned Credentials to a specific recipient user identifier (ID) you set whilst creating Credentials.

license_idstring

Limit the returned Credential to a specific credential id you set whilst creating credential.

start_datestring

Date after which credentials issued should be return. Format: YYYY-MM-DD (DD/MM/YYYY also works but is deprecated)

end_datestring

Date before which credetials issued should be return. Format: YYYY-MM-DD (DD/MM/YYYY also works but is deprecated)

start_updated_datestring

Date after which Credentials updated should be returned. Format: YYYY-MM-DD (DD/MM/YYYY also works but is deprecated)

end_updated_datestring

Date before which Credetials updated should be returned. Format: YYYY-MM-DD (DD/MM/YYYY also works but is deprecated)

page_sizenumber

The pagination response size, default of 50.

pagenumber

The pagination page.

Response

Changes

Changed in 7 of the 30 revisions of this API.1419

Aug 6, 2026dc79460d92221See the full diff
- ○
  added the required property credentials/items/skills to the response with the 200 status
  response-required-property-added
Nov 5, 2025f494f7d363071See the full diff
- ○
  added the optional property credentials/items/recipient/phone_number to the response with the 200 status
  response-optional-property-added
Sep 8, 2025cac96b8772c31See the full diff
- ○
  endpoint deprecated
  endpoint-deprecated
Jul 29, 202594e03fe9537b2See the full diff
- ○
  added the optional property credentials/items/encoded_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property credentials/items/seo_image to the response with the 200 status
  response-optional-property-added
Jul 4, 20257b8d90ce110b1See the full diff
- ○
  api operation id Search for Credentials removed and replaced with Search for Credentials (v1)
  api-operation-id-removed
Jul 4, 2025a93800de3a851312See the full diff
- ●
  deleted the query request parameter end_date
  request-parameter-removed
- ●
  deleted the query request parameter end_updated_date
  request-parameter-removed
- ●
  deleted the query request parameter group_id
  request-parameter-removed
- ●
  deleted the query request parameter license_id
  request-parameter-removed
- ●
  deleted the query request parameter meta_data
  request-parameter-removed
- ●
  deleted the query request parameter page
  request-parameter-removed
- ●
  deleted the query request parameter page_size
  request-parameter-removed
- ●
  deleted the query request parameter recipient.email
  request-parameter-removed
- ●
  deleted the query request parameter recipient.id
  request-parameter-removed
- ●
  deleted the query request parameter recipient.meta_data
  request-parameter-removed
- ●
  deleted the query request parameter recipient.name
  request-parameter-removed
- ●
  deleted the query request parameter start_date
  request-parameter-removed
- ●
  deleted the query request parameter start_updated_date
  request-parameter-removed
- ○
  added the new optional request property end_date
  new-optional-request-property
- ○
  added the new optional request property end_updated_date
  new-optional-request-property
- ○
  added the new optional request property group_id
  new-optional-request-property
- ○
  added the new optional request property license_id
  new-optional-request-property
- ○
  added the new optional request property page
  new-optional-request-property
- ○
  added the new optional request property page_size
  new-optional-request-property
- ○
  added the new optional request property recipient.email
  new-optional-request-property
- ○
  added the new optional request property recipient.id
  new-optional-request-property
- ○
  added the new optional request property recipient.meta_data
  new-optional-request-property
- ○
  added the new optional request property recipient.name
  new-optional-request-property
- ○
  added the new optional request property start_date
  new-optional-request-property
- ○
  added the new optional request property start_updated_date
  new-optional-request-property
Jun 30, 202598201e8dd1b411See the full diff
- ●
  deleted the header request parameter Authorization
  request-parameter-removed
- ○
  the endpoint scheme security ApiKeyAuth was added to the API
  api-security-added

Full history