Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
group

Find groups in the organization of a certain type

get/v2/org/{orgId}/group/graph

Path parameters

orgIdstring required

Org identifier (either id or slug)

Query parameters

startstring

group id to use as the starting point

depthinteger

number of levels down

groupApproxLimitinteger

limit number of groups

jobLimitinteger

limit number of jobs

scenarioIdstring

scenario id to query

jobFilterstring

query string to filter jobs by

groupFilterstring

query string to filter group by

datestring date

date to search as of

groupFieldsstring

group fields to return

jobFieldsstring

job/person fields to return

formatstring

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

groupTypestring

groupType

groupTypeIdstring

groupTypeId

Response

successful operation

nextIdstring

Example response

{
  "data": [
    {
      "parent": {
        "id": "588f7ee98f138b19220041a7",
        "type": "GROUP"
      }
    }
  ],
  "nextId": "588f7ee98f138b19220041a7"
}