Credentials

Search for Credentials (v2)

This is a faster alternative to the v1 Search API. It also supports operations on the query fields which can allow you to form more complex queries.

Following operations are supported based on the field. You can also combine operations on multiple fields:

Operation	Description	Example
eq	Exact match (default, if nothing specified).	{"group.id[eq]": 1} or {"group.id": 1} - Both yield the same result.
in	Allows an array of values.	{"group.id[in]": [1, 2]}
lt	Less than.	{"issued_on[lt]": "2023-12-31"}
gt	Greater than.	{"issued_on[gt]": "2023-01-01"}
lte	Less than equal to.	{"expired_on[lte]": "2023-12-31"}
gte	Greater than equal to.	{"expired_on[gte]": "2023-01-01"}

Note: Offset-based pagination using page.from + page.size supports a maximum of 10,000 results. To retrieve results beyond this limit, use cursor-based pagination with page.cursor and page.size.

Note: Results from this endpoint do not carry the skills field that the other credential endpoints return. To read a credential's framework skills, fetch it with View a Credential.

post/v2/credentials/search

Request body

Response

Changes

Changed in 8 of the 30 revisions of this API.20725

Jan 7, 2026e6fe9658dfa91See the full diff
- ○
  added the optional property credentials/items/group/phone_number to the response with the 200 status
  response-optional-property-added
Jan 7, 2026790286a7660422See the full diff
- ▲
  the page/from request property type/format changed from string/ to integer/
  request-property-type-changed
- ▲
  the page/size request property type/format changed from string/ to integer/
  request-property-type-changed
- ○
  added the new optional request property page/cursor
  new-optional-request-property
- ○
  added the optional property meta/cursor to the response with the 200 status
  response-optional-property-added
Dec 26, 202597033e03fe0718617See the full diff
- ▲
  the response property credentials/items/custom_attributes became optional for the status 200
  response-property-became-optional
- ▲
  the response property credentials/items/expired_on became optional for the status 200
  response-property-became-optional
- ▲
  the response property credentials/items/grade became optional for the status 200
  response-property-became-optional
- ▲
  the response property credentials/items/id became optional for the status 200
  response-property-became-optional
- ▲
  the response property credentials/items/issued_on became optional for the status 200
  response-property-became-optional
- ▲
  the response property credentials/items/meta_data became optional for the status 200
  response-property-became-optional
- ▲
  the response property credentials/items/name became optional for the status 200
  response-property-became-optional
- ▲
  the response property credentials/items/private became optional for the status 200
  response-property-became-optional
- ▲
  the credentials/items/custom_attributes response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the credentials/items/expired_on response's property type/format changed from / to string/ for status 200
  response-property-type-changed
- ▲
  removed the required property credentials/items/allow_supplemental_evidence from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property credentials/items/allow_supplemental_references from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property credentials/items/complete from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property credentials/items/course_link from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property credentials/items/description from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property credentials/items/group_name from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property credentials/items/issuer from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property credentials/items/recipient from the response with the 200 status
  response-required-property-removed
- ●
  removed the optional property credentials/items/meta_data/foo from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property meta/current_page from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property meta/next_page from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property meta/prev_page from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property meta/total_count from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property meta/total_pages from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property credentials/items/approve to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property credentials/items/created_at to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property credentials/items/group to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property credentials/items/issuer_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property credentials/items/license_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property credentials/items/published_on to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property credentials/items/recipient_email to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property credentials/items/recipient_engaged to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property credentials/items/recipient_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property credentials/items/recipient_meta_data to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property credentials/items/recipient_name to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property credentials/items/recipient_opened to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property credentials/items/updated_at to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property credentials/items/uuid to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property meta/count to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property meta/from to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property meta/size to the response with the 200 status
  response-optional-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
Jul 29, 202594e03fe9537b1See the full diff
- ○
  added the media type application/json for the response with the status 200
  response-media-type-added
Jul 8, 2025d146e0a98f941See the full diff
- ○
  added the new optional request property query/uuid
  new-optional-request-property
Jul 4, 20257b8d90ce110b1See the full diff
- ○
  api operation id Search for Credentials removed and replaced with Search for Credentials (v2)
  api-operation-id-removed
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