v3

latestSwagger 2.02026-08-067506752.0 MB

person

Find persons in the organization to invite as users

get/v2/org/{orgId}/person/query-invite-users

orgIdstring required

Org identifier (either id or slug)

qstring

Search query

isPreboardingboolean

Whether you are searching for preboarding or activated users

fromstring

Person id to start paginating from

limitinteger

Number of results to return

formatstring

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

sortstring

Sort field, prefix with - for descending (e.g. name, -name, startDate, -startDate)

persons found

dataobject[] required

nextstring

totalRowobject

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