v1

latestOpenAPI 3.1.02026-07-2466150275.0 KB

Certificates

Search Certificates

Search for certificates that match the provided search terms.

Keywords are search for in the certificate name, certificate type and certification provider fields.

Additional explicit filters are also supported

get/v1/certificate/

Query parameters

querystring nullable

skipinteger nullable

limitinteger nullable

sort_direction'asc' | 'desc'

Direction to sort the sort_column - ascending or descending.

date_startstring date-time nullable

date_cut_offstring date-time nullable

sort_column'updated_at' | 'created_at' | 'id'

Which column to sort on

namestring nullable

certification_typestring nullable

company_certification_type_idinteger nullable

user_idinteger nullable

offlineboolean nullable

archivedboolean nullable

approvedboolean nullable

subcontractor_idinteger nullable

expiredboolean nullable

expiry_date_fromstring date-time nullable

expiry_date_tostring date-time nullable

provider_idinteger nullable

provider_namestring nullable

created_afterstring date-time nullable

created_beforestring date-time nullable

Response

Successful Response

errorboolean

A boolean error indicator.

messagestring nullable

Optional message.

Example response

{
  "data": [
    {
      "id": 1,
      "type": "First Aid",
      "userId": 1,
      "companyCertificationType": "First Aid Level 1",
      "companyCertificationTypeId": 12,
      "expiryDate": "2027-07-17T21:40:53.246164",
      "issueDate": "2026-07-17T21:40:53.246196",
      "approved": true,
      "offline": true,
      "provider": "Salus Pro",
      "providerId": 15,
      "userName": "Daniel Patterson"
    }
  ]
}