Sign in

v1

latestOpenAPI 3.1.02026-08-04164270844.7 KB
Users

List all certificates for a user

🔑

Required OAuth scope: users:read.

📖

This endpoint is paginated with a page size of 1,000 certificates. For more information, see the Pagination guide.

Lists all certificates in your platform for a given user.

get/api/v2/users/{userId}/certificates

Path parameters

userIdstring ObjectId required
Example:507f1f77bcf86cd799439011

The unique ID of the user.

Query parameters

ltstring date-time

Filter on dates lower than the given one

gtestring date-time

Filter on dates greater than or equal the given one

Filter on deliveryDate property with LHS bracket notation.

Expected value format is a date (YYYY-MM-DDThh:mm:ss.sssZ). The milliseconds are always set to 0.

{
  "lt": "2020-01-01T10:30:26.000Z",
  "gte": "2020-01-01T10:30:26.000Z"
}
ltstring date-time

Filter on dates lower than the given one

gtestring date-time

Filter on dates greater than or equal the given one

Filter on expirationDate property with LHS bracket notation.

Expected value format is a date (YYYY-MM-DDThh:mm:ss.sssZ). The milliseconds are always set to 0.

{
  "lt": "2020-01-01T10:30:26.000Z",
  "gte": "2020-01-01T10:30:26.000Z"
}

Headers

360-api-version'v2.0' required

The version of the API.

Response

Returns one page of 1000 certificates.

Example response

[
  {
    "title": "Certificate of Completion",
    "_id": "507f1f77bcf86cd799439011",
    "certificateOutlineId": "507f1f77bcf86cd799439011",
    "type": "external"
  }
]