List people

Returns a list of people associated with a given account.

You can use the include parameter to retrieve additional details about people.

SecurityCommonAuth
Request
query Parameters
accountId
required
string (accountId)

The ID of the account to work with.

Example: accountId=F50091
limit
integer <int32> (limit) [ 1 .. 100000 ]
Default: 100

The maximum number of items to return.

Example: limit=100
offset
integer <int32> (offset)
Default: 0

The number of items to skip before returning the results.

Example: offset=200
search
string (search)

The term to search the records for.

Example: search=Cesar+Treutel
include
Array of any

Optional embeds to include when returning people.

Items Enum: "persona.addresses" "persona.createdBy" "persona.teams" "persona.primaryOwnerOf" "persona.roles"
Example: include=persona.addresses
status
Array of strings

Filter people by their status on the account. Use commas to pass multiple values. Has to be URL encoded.

Items Enum: "active" "deactivated" "created" "invited" "inviteExpired"
Example: status=active%2Ccreated
teams
Array of strings

Filter people by team.

Example: teams=02a42ec7-67d3-4fce-87b5-199080327ab9
roles
Array of strings

Filter people by role.

Example: roles=02a42ec7-67d3-4fce-87b5-199080327ab9
roleNames
Array of strings

Filter people by role name. Use commas to pass multiple values. Has to be URL encoded.

Example: roleNames=Admin
people
Array of strings

Filter people by personId. Use commas to pass multiple values. Has to be URL encoded.

Example: people=11e6ff45-c6b1-40c7-8551-46dd74536551
withoutIndividualBudget
boolean

Filter people without an individual budget.

Example: withoutIndividualBudget=true
budgetId
Array of strings <uuid>

The list of IDs of the Budgets to work with

Example: budgetId=b489ea2c-0dd1-4fb1-b345-de5a596a5527
Responses
200

OK

400

Bad request

401

Unauthorised

403

Forbidden

404

Not found

405

Method not allowed

415

Unsupported media type

429

Too many requests

500

Internal server error

get/people
Request samples 
Response samples 
application/json
{
  • "limit": 100,
  • "offset": 200,
  • "count": 67,
  • "search": "string",
  • "rows": [
    ]
}