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

Changes

Changed in 7 of the 30 revisions of this API.187

Aug 6, 2026dc79460d92222See the full diff
- ○
  added the required property // to the response with the status
  response-required-property-added
- ○
  added the required property // to the response with the status
  response-required-property-added
May 25, 202690d8939c6beb1See the full diff
- ○
  added the new optional request property
  new-optional-request-property
May 15, 202697793c5df9501See the full diff
- ○
  added the required property // to the response with the status
  response-required-property-added
Mar 23, 2026ecf2792b95921See the full diff
- ○
  added the new optional request property
  new-optional-request-property
Dec 25, 20255daf146bc8ba1See the full diff
- ○
  added the optional property // to the response with the status
  response-optional-property-added
Jul 4, 20254d5375b411d317See the full diff
- ▲
  added required request body
  request-body-added-required
- ●
  deleted the query request parameter end_updated_date
  request-parameter-removed
- ●
  deleted the query request parameter ids
  request-parameter-removed
- ●
  deleted the query request parameter meta_data
  request-parameter-removed
- ●
  deleted the query request parameter name
  request-parameter-removed
- ●
  deleted the query request parameter page
  request-parameter-removed
- ●
  deleted the query request parameter page_size
  request-parameter-removed
- ●
  deleted the query request parameter start_updated_date
  request-parameter-removed
Jun 30, 202598201e8dd1b411See the full diff
- ●
  deleted the header request parameter Authorization
  request-parameter-removed
- ○
  the endpoint scheme security ApiKeyAuth was added to the API
  api-security-added

Full history