Sign in
Groups

Search for groups

get/api/v1/{tenant}/groups/search

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/{tenant}/groups/search
  • Auth: one of:
    • HTTP bearer
    • HTTP basic

Path parameters

tenantstring required

Query parameters

qstring nullable

A string filter

pageinteger required

The current page

sizeinteger required

The current page size

sortstring[] nullable

The sort of current page

Response

searchGroups 200 response

totalinteger required

Example response

{
  "total": 0,
  "results": [
    {
      "name": "name",
      "id": "id"
    },
    {
      "name": "name",
      "id": "id"
    }
  ]
}

Changes

No recorded changes to this operation across all 7 revisions of this API.