Groups
Search for Groups
post/v1/issuer/groups/search
Request body
idsnumber[]
Limit the list of Groups to those id match the given array.
namestring
Limit the list of Groups to those named with the given string. Supports partial matching.
course_namestring
Limit the list of Groups to those whose course name matches the given string. Supports partial matching.
department_idnumber
Limit results to a particular Department. Must be a Department accessible to the API key being used; otherwise a 400 Bad Request is returned. When omitted, results include all Departments the API key can access.
meta_dataobject
Key/values for client's own data on group
start_updated_datestring date
Date after which Groups which have been updated should be returned. Format: YYYY-MM-DD
end_updated_datestring date
Date before which Groups which have been updated should be returned. Format: YYYY-MM-DD
page_sizenumber
The pagination response size, default of 50.
pagenumber
The pagination page.
Response
OK