Skip to main content

Drivers: license expiring

1 operation at https://api.zaitrack.app. Request and response bodies are JSON with camelCase keys; ids are UUIDs; times are RFC 3339 in UTC.

Every operation needs an API key, a personal access token or an OAuth access token unless it says otherwise. An Idempotency-Key is replayed for 24 hours; see Idempotency. Errors are application/problem+json; see Errors.

Drivers whose licence expires soon​

GET /v1/drivers/license-expiring

  • Scope: drivers:read or drivers:*
  • Rate class: read (100 per second and 360,000 per hour)
  • Idempotency-Key: not used
  • Audited: no
  • Step-up MFA: no
Query parameterTypeNotes
daysstring

Request​

No body.

Response​

200: fields the handler writes, taken from its source.

FieldTypeNotes
itemsarray of object
items[].idstring
items[].tenantIdstring
items[].subOrgIdstringomitted when empty
items[].employeeNumberstring
items[].firstNamestring
items[].lastNamestring
items[].dateOfBirthstring
items[].nationalIdMaskedstringomitted when empty
items[].emailstringomitted when empty
items[].phonestringomitted when empty
items[].statusstring
items[].hireDatestring
items[].terminationDatestringomitted when empty
items[].licenseobject
items[].license.numberstring
items[].license.countrystring
items[].license.classesarray of string
items[].license.issuedAtstringomitted when empty
items[].license.expiresAtstring
items[].license.endorsementsarray of stringomitted when empty
items[].license.LocalClass—
items[].license.authoritystringomitted when empty
items[].license.localClassstringomitted when empty
items[].licenseValidboolean
items[].qualificationsarray of object
items[].qualifications[].codestring
items[].qualifications[].issuedAtstring
items[].qualifications[].expiresAtstringomitted when empty
items[].qualifications[].issuingBodystringomitted when empty
items[].homeRegionstringomitted when empty
items[].languagesarray of string
items[].assignableboolean
items[].nationalitystringomitted when empty
items[].employmentstring
items[].contractorCompanystringomitted when empty
items[].photoobjectmay be null
items[].photo.contentTypestring
items[].photo.sizeinteger
items[].photo.updatedAtstring
items[].photo.updatedBystringomitted when empty
items[].createdAtstring
items[].updatedAtstring
items[].versioninteger
days—

Example​

curl "https://api.zaitrack.app/v1/drivers/license-expiring" \
-H "Authorization: Bearer zk_test_…"