v3

latestSwagger 2.02026-08-067506752.0 MB

person

Find persons in the organization, grouped by an expression

get/v2/org/{orgId}/person/group-by

orgIdstring required

Org identifier (either id or slug)

scenarioIdstring

Scenario id to query

startDatestring date

Start date, if retrieving persons that existed between two dates (inclusive)

endDatestring date

End date, if retrieving persons that existed between two dates (inclusive)

qstring

Search query

columnsstring

Fields to retrieve with their aggregation function, comma-separated

groupBystring

Expression to group by

sortstring

Sort by fields, comma-separated. For descending sort, prepend a -

formatstring

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

splitColumnsboolean

Whether to split complex columns, used for tabular data formats

successful operation

dataobject[] required

nextstring

totalRowobject

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