Get
/cpdRequirementSummaries
Retrieves multiple CPD requirements (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": 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
}
]
}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