Query CPD requirements

  • Updated on Feb 19, 2026
  • Published on Oct 27, 2025
  • 1 minute(s) read
Prev Next
Get
/cpdRequirementSummaries

Retrieves multiple CPD requirements (up to 1,000 per page) with pagination

Security
HTTP
Type basic

HTTP Basic authentication using your Tenant ID and API secret.

  • Username is the Tenant ID (i.e. eu-west-2_AbcdEfghI)
  • Password is the API secret you would have received.

You can also authenticate using OAuth 2.0 client credentials (oauth2 security scheme) instead of Basic auth.

OAuth

OAuth 2.0 client credentials authentication.

Use the following token endpoints (replace :tenantId with your Tenant ID):

  • Public API access tokens

    • Staging: https://public.api.learnstaging.link/oauth2/token/:tenantId
    • Production: https://public.api.learn.link/oauth2/token/:tenantId
    • Staging MEA: https://public.api.meastaging.learn.tech/oauth2/token/:tenantId
    • Production MEA: https://public.api.mea.learn.tech/oauth2/token/:tenantId

  • Webhooks access tokens

    • Staging: https://user.api.learnstaging.link/oauth2/token/:tenantId
    • Production: https://user.api.learn.link/oauth2/token/:tenantId
    • Staging MEA: https://user.api.meastaging.learn.tech/oauth2/token/:tenantId
    • Production MEA: https://user.api.mea.learn.tech/oauth2/token/:tenantId

All access tokens must be sent using the Authorization: Bearer <access_token> header.

Scopes

For API access (non-webhooks), the following scopes are available:

  • api/all – Full read and write access to the API.
  • api/read – Read-only access to the API.
  • api/write – Write access to the API.

For webhooks, the following scopes are available:

  • api/webhooks – Access to webhook functionality.
  • api/all – Full read and write access to the API, including webhooks.

Tokens must include appropriate scopes for the endpoints you wish to call.

FlowClient Credentials
Token URLhttps://public.api.learn.link/oauth2/token/:tenantId
Query parameters
page
integer

Page number for pagination

Minimum1.0
Default1
Example1
perPage
integer

Number of records per page

Minimum1.0
Maximum1000.0
Default100
Example20
Responses
200

Successful response

{
  "pagination": {
    "totalResults": 2,
    "totalPages": 1,
    "page": 1,
    "perPage": 20
  },
  "results": [
    {
      "audienceRequirementId": "60d5ec49b60b4b3a2c8f9a10",
      "audienceId": "60d5ec49b60b4b3a2c8f9a11",
      "requiredMinutes": 660,
      "createdAt": "2020-05-27T10:44:05.687Z",
      "updatedAt": "2020-08-05T09:37:47.824Z"
    },
    {
      "audienceRequirementId": "64b6f4a8c2e4a1b9d3f2c4a0",
      "audienceId": "64b6f4a8c2e4a1b9d3f2c4a1",
      "requiredMinutes": 1200,
      "createdAt": "2020-06-11T21:03:55.798Z",
      "updatedAt": null
    }
  ]
}
Expand All
object
pagination
object (Pagination)

Details of the pagination

totalResults
integer

Total number of results matching the query

Example48
totalPages
integer

Total number of pages available

Example3
page
integer

Current page number

Minimum1.0
Default1
Example1
perPage
integer

Number of results per page

Minimum1.0
Maximum1000.0
Default100
Example20
results
Array of object (CPDRequirement)
object
audienceRequirementId
string

Unique ID for this requirement record

Pattern^[0-9a-fA-F]{24}$
Example64b6f4a8c2e4a1b9d3f2c4a2
audienceId
string

ID of the audience this requirement applies to

Pattern^[0-9a-fA-F]{24}$
Example5f9d88d6e1b2a34c56d78901
requiredMinutes
integer

Number of minutes required for CPD completion

Minimum0.0
Example660
createdAt
string (date-time)

Timestamp when the requirement was created

Example2020-05-27T10:44:05.687Z
updatedAt
string (date-time) | null

Timestamp when the requirement was last updated

Example2020-08-05T09:37:47.824Z