GET multiple Groups

get

{protocol}://{base-url}/integration/v1/group/

This API is used to list all Groups.

Query Params

display_name

string

Filter by an exact match on display_name

display_name__contains

string

Filter by a case-sensitive substring on display_name

display_name__icontains

string

Filter by a case-insensitive substring on display_name

string

Filter by an exact match on email

email__contains

string

Filter by a case-sensitive substring on email

email__icontains

string

Filter by a case-insensitive substring on email

integer

≥ 1

Filter by Group ID. Multiple IDs can be specified using the format ?id=1&id=2.

limit

integer

≥ 1

Defaults to 100

The number of items to return.

profile_id

integer

≥ 1

Filter by Group Profile ID. Multiple IDs can be specified using the format ?profile_id=1≺ofile_id=2.

skip

integer

Defaults to 0

The number of items to skip.

order_by

string

enum

Sort by a specified property:

display_name - A to Z, by display_name
-display_name - Z to A, by display_name
email - A to Z, by email
-email - Z to A, by email
id - Ascending by id
-id - Descending by id
profile_id - Ascending by id
-profile_id - Descending by id

values

string

A comma-separated sub-set of properties to select for each item.

Responses

Language

Credentials

Header

URL

Loading…

Response

Choose an example:

application/json

200Requested Groups

400Malformed Request

401Unauthorized bad/missing token

403Forbidden User cannot edit this resource

404The specified resource was not found

500Internal Server Error