group

Find groups in the organization of a certain type

get/v2/org/{orgId}/group

Request

  • Base URL: https://localhost
  • URL: https://localhost/v2/org/{orgId}/group
  • Auth: none declared

Path parameters

orgIdstring required

Org identifier (either id or slug)

Query parameters

typestring

Group type

scenarioIdstring

Scenario id to query

datestring date

Date to search as of

fromstring

Group id to start paginating from

limitinteger

Number of results to return

fieldsstring

Fields to retrieve, comma-separated

jobFieldsstring

job fields to return, comma-separated

timeFilter'CURRENT' | 'ARCHIVED' | 'FUTURE' | 'ALL'

Temporal filter for groups: CURRENT (default, groups existing on date), ARCHIVED (deleted groups), FUTURE (future-dated groups), ALL (all groups)

includeAllboolean

Deprecated: use timeFilter=ALL instead. Include all groups, including deleted groups.

returnAccessstring

Return access information -- pass a list of actions to check, for example: create,update,delete

searchstring

Search string to filter on code & name

formatstring

Data format to use; default is json, can also use json-extended or json-readable

idsstring

Comma-separated list of group ids to look up

Response

successful operation

dataobject[] required
nextstring
totalRowobject

Example response

{
  "access": [
    {
      "ids": [
        "588f7ee98f138b19220041a7"
      ]
    }
  ]
}

Changes

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