Groups
Partners

Search groups for an organization.

Changed on

Returns the organization's groups, filtered by any combination of the query parameters below. Filters are combined with AND. If no filter is supplied, all groups are returned.

Query parameters:

  • name (optional, case-insensitive, starts-with)
  • externalId (optional, exact match) - the group's ID from an external group provider
  • externalReferenceId (optional, exact match) - reference identifier defined via the admin console
  • groupTypeId (optional) - restrict to one layer of the hierarchy
  • pageIndex (optional, integer, first page is 0)
  • pageSize (optional, integer, max size is 1000)

Notes:

  • The search may return more than one result. externalReferenceId is an administrator-supplied free-text value and is not guaranteed to be unique.
  • externalReferenceId may contain any character, including & and =. Use your HTTP client's query parameter encoding rather than building the URL by hand.
  • Results are paginated and ordered by group name. The maximum page size is 1000.
  • Both active and inactive groups are returned. Check the isActive attribute before assigning members; inactive groups will not accept new members.
  • A group is inactive if it has been deactivated directly or if any of its ancestors have been deactivated.
get/api/partners/orgs/{orgId}/groups

Request

  • Base URL: https://api.mobilecoach.org (the document declares no server; this is the origin it was published from)
  • URL: https://api.mobilecoach.org/api/partners/orgs/{orgId}/groups
  • Auth: AuthToken (a scheme the document does not define)

Path parameters

orgIdinteger required

Query parameters

namestring
externalIdstring
externalReferenceIdstring
groupTypeIdinteger
pageIndexinteger

Page Index (starts at zero)

pageSizeinteger

Page Size (max 1000)

Response

OK

totalItemCountinteger required
hasPreviousboolean
hasNextboolean
totalPagesinteger
isLastboolean
isFirstboolean
itemCountinteger

Changes