Gets all people in the given account.

get

https://bench.gobridgit.com/rp/api/v1/accounts/{accountId}/Persons

NOTE: If there are more persons in the account than were returned, there will be a "query-has-more" header that will be set to true.
Permissions
HourlyProfile: Read
Person: Read
Finance: Read

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

int32

required

The Account ID

Query Params

relativeDate

date-time

Optional paramater used to calculate date based properties. If not provided, it is set to today's date in UTC.

offset

int32

0 to 2147483647

Defaults to 0

Offset for pagination

limit

int32

1 to 2147483647

Defaults to 1000

Maximum number of results in this page

string

Filter user with email

state

string

enum

Defaults to Active

If specified and not 'Unknown', only include people matching the given state. The available values are defined as follows:

Unknown: By default, includes only Active people.
Active: include only Active people
Deactivated: include only Deactivated people
All: include all people, regardless of state

Allowed:

ids

array of int64s

Optional paramater of comma delimited ids for filtering results based on the person IDs provided

ids

uniqueId

string

Optional paramater of unique identifier for filtering results based on the person unique identifier provided

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

200Success: List of persons in the account