Query CPD categories

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

Retrieves multiple CPD categories (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": 27,
    "totalPages": 2,
    "page": 1,
    "perPage": 20
  },
  "results": [
    {
      "categoryId": "60d5ec49b60b4b3a2c8f9a10",
      "name": "ANIMALS"
    },
    {
      "categoryId": "60d5ec49b60b4b3a2c8f9a11",
      "name": "BOOKS"
    },
    {
      "categoryId": "64b6f4a8c2e4a1b9d3f2c4a0",
      "name": "CLIENTS"
    },
    {
      "categoryId": "64b6f4a8c2e4a1b9d3f2c4a1",
      "name": "COFFEE"
    },
    {
      "categoryId": "64b6f4a8c2e4a1b9d3f2c4a2",
      "name": "COOKING"
    }
  ]
}
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 (CPDCategory)
object
categoryId
string

Unique ID for this category record

Pattern^[0-9a-fA-F]{24}$
Example5c8936159ec2d00010cdd334
name
string

Name of the category of CPD activity

Max length250
ExamplePersonal Reading