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

The ID of the account to work with.

Example: accountId=F50091
limit
integer [ 1 .. 1000 ]
Default: 100

The maximum number of results to return.

Example: limit=200
offset
integer
Default: 0

The number of items to skip before returning results.

Example: offset=100
search
string <= 100 characters

The term to search the records for.

Example: search=Cesar+Treutel
status
string

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

Enum: "active" "deactivated" "created" "invited" "inviteExpired"
Example: status=active,deactivated
teams
string

Filter people by team.

addresses
string

Filter people by address.

roles
string

Filter people by role.

roleNames
string

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

Enum: "Admin" "Balance payer" "Balance viewer" "Owner" "Balance user" "Payer" "Balance admin" "Viewer" "User" "Accountant"
Example: roleNames=Owner,Admin
people
string

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

budgetId
string

The list of IDs of the Budgets to work with

withoutIndividualBudget
string

Filter people without an individual budget.

Enum: "true" "false"
include
string

Optional embeds to include when returning people.

Enum: "persona.addresses" "persona.createdBy" "persona.teams" "persona.primaryOwnerOf" "persona.roles"
Example: include=persona.addresses
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

415

Unsupported Media Type

422

Unable to process the request

429

Too Many Requests

500

Internal Server Error

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