Skip to main content
GET
Get groups

Headers

X-Delogue-Api
string

Query Parameters

Free-text search matched as a substring against the group name and user-defined identifier.

Ids
integer<int64>[]

Restricts results to groups with any of these identifiers.

Names
string[]

Restricts results to groups whose name exactly matches any of these values.

UserDefinedId
string

Restricts results to the group with this exact user-defined identifier.

State
enum<string>

Restricts results to groups in this lifecycle state. Current lifecycle state of the group.

Available options:
active,
inactive,
deleted
BeginDateFrom
string<date-time>

Restricts results to groups whose begin date is on or after this ISO 8601 date-time.

BeginDateTo
string<date-time>

Restricts results to groups whose begin date is on or before this ISO 8601 date-time.

EndDateFrom
string<date-time>

Restricts results to groups whose end date is on or after this ISO 8601 date-time.

EndDateTo
string<date-time>

Restricts results to groups whose end date is on or before this ISO 8601 date-time.

sort
object[]

Repeat the parameter per sort column: sort[0].property=<column>&sort[0].order=Ascending|Descending, sort[1].... for a secondary column. order accepts asc, desc, ascending or descending (case-insensitive) and may also be spelled direction. Mutually exclusive with cursor. Sortable columns include: Id, Name, UserDefinedId, State, BeginDate, EndDate.

pageSize

Number of groups to return per page. Defaults to 30, maximum 100.

pageNumber

The 1-based page number to return. Defaults to 1.

cursor
string

Opaque keyset pagination token. Mutually exclusive with the filter, sort, pageSize and pageNumber parameters.

Response

OK

status
enum<string>
required

The coarse outcome of the request, indicating whether it succeeded or failed.

Available options:
success,
error
code
string
required

The specific machine-readable outcome code, such as ok on success or the most specific error code on failure. Always lowercase on the wire.

data
object[]
required

The page of results, always an array. An empty page is an empty array rather than null or an omitted field.

pagination
object
required

Paging metadata for this response, carrying whether more rows remain and the cursor used to request the next page.