Get
/cpdCategories
Retrieves multiple CPD categories (up to 1,000 per page) with pagination
Security
HTTP
Type basic
To pass the authentication step you will need to provide the following:
Username is the Tenant ID (i.e. eu-west-2_AbcdEfghI) Password is the secret you would have received
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"
}
]
}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