Sign in

v1

latestOpenAPI 3.1.02026-08-04164270844.7 KB
Certificate Outlines

List all certificate outlines

🔑

Required OAuth scope: certificateOutlines:read.

Lists all certificate outlines in your platform.

get/api/v2/certificate-outlines

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 createdAt 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"
}
eqstring ObjectId

Filter on values equal to the given one

nestring ObjectId

Filter on values not equal to the given one

instring[]

Filter on values including the given ones

ninstring[]

Filter on values excluding the given ones

Filter on groupId property with LHS bracket notation.

Expected value format is a valid ID (24 digits or letters).

{
  "eq": "507f1f77bcf86cd799439011",
  "ne": "507f1f77bcf86cd799439011",
  "in": [
    "507f1f77bcf86cd799439011"
  ],
  "nin": [
    "507f1f77bcf86cd799439011"
  ]
}

Headers

360-api-version'v2.0' required

The version of the API.

Response

Returns all certificate outlines in the company.

titlestring required

The title of the certificate outline.

groupIdstring ObjectId required

The unique ID of the group this outline belongs to.

_idstring ObjectId required

The unique ID of the certificate outline.

createdAtstring date-time required

The date and time when the certificate outline was created, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

Example response

[
  {
    "title": "Certificate of Completion",
    "groupId": "507f1f77bcf86cd799439011",
    "_id": "507f1f77bcf86cd799439011"
  }
]