List client courses

get

http://api-gateway-eu.phorest.com/third-party-api-server/api/business/{businessId}/clientcourse

Get a list of client courses for the specified business id. List can be filtered by branch id, client id and a possibility to include archived client courses or courses with no remaining units.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

businessId

string

required

Query Params

branch_id

string

branch id to filter by

client_id

string

client id to filter by

includeArchived

boolean

include archived client courses in the list

includeUsedCourseItems

boolean

include course items with no remaining units

updated_from

string

start of the updated date-time range (inclusive), ISO-8601 date-time in UTC. Returns client courses whose updateTime is on or after this value. Must be supplied together with updated_to, and the range can be at most 31 days

updated_to

string

end of the updated date-time range (exclusive), ISO-8601 date-time in UTC. Returns client courses whose updateTime is before this value. Must be supplied together with updated_from, and the range can be at most 31 days

size

integer

Defaults to 20

number of client course records to return, max is 200

page

integer

Defaults to 0

page number, default is 0 and is optional

Responses

200Client courses listed

400Invalid request parameters. Returned when only one of updated_from and updated_to is supplied (both are required together), the range spans more than 31 days, or a value is not a valid ISO-8601 date-time

404Business with the specified id doesn't exist

429Request rate limit exceeded. Current limit set to 100 rps.

500Internal Server Error