v3

latestSwagger 2.02026-08-067506752.0 MB

person

Find persons in the organization

get/v2/org/{orgId}/person

Path parameters

orgIdstring required

Org identifier (either id or slug)

Query parameters

scenarioIdstring

Scenario id to query

datestring date

Date to search as of

startDatestring date

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

endDatestring date

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

qstring

Search query

idsstring

Comma-separated list of person ids to look up

fromstring

Person id to start paginating from

limitinteger

Number of results to return

sortstring

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

fieldsstring

Fields to retrieve, comma-separated

fieldsListstring[]

Fields to retrieve, list syntax

includeAllboolean

Include all persons in the system, including ex-employees or persons who were never in jobs

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

returnAccessstring

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

rangeEvalDate'START' | 'END'

For a startDate/endDate range, which date within the range to evaluate each person's fields as-of: START (earliest date they hold a job) or END (default, latest date they hold a job)

Response

persons found

dataobject[] required

nextstring

totalRowobject

Example response

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