Skip to main content
GET
/
people
List people
curl --request GET \
  --url https://api.equalsmoney.com/v2/people \
  --header 'Authorization: <api-key>'
{
  "limit": 200,
  "offset": 100,
  "count": 67,
  "rows": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "firstName": "Dolly",
      "lastName": "Parton",
      "title": "Master",
      "middleInitials": "R",
      "dob": "1946-01-19",
      "gender": "Female",
      "nationality": "US",
      "nationalities": [
        "GB"
      ],
      "countryOfResidence": "US",
      "primaryMobileNumber": "+447798121212",
      "primaryEmailAddress": "test@equalsqa.com",
      "avatar": {
        "url": "string",
        "fileName": "string"
      },
      "sendInvite": true,
      "roleId": "7382d58e-652a-4905-b7c9-bcca1e0e5391",
      "verifyEmailAddress": true,
      "verifyMobileNumber": true,
      "sub": "8e214819-5c83-429f-a976-eb127a0a8a88 or auth0|12345a6b7890c1def1234dg5",
      "hasPeopleCard": true,
      "card": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "status": "active",
      "locale": "en-GB",
      "productId": "3ef24d53-6e22-4103-a16b-d268e4f7346d",
      "avatarId": "ac572b6e-802b-4b9e-a602-0786d4441e67",
      "avatarCdnUrl": "string",
      "emailTheme": "string",
      "preferred2FAMethod": "whatsapp",
      "persona": {},
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "address": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "personId": "775596ae-2624-40af-a9dc-9756110a4a04",
        "streetName": "Great Building",
        "buildingNumber": "10",
        "buildingName": "Greater Building",
        "postcode": "SE13UB",
        "city": "My Town",
        "region": "Greater London",
        "countryCode": "GB"
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Query Parameters

​
accountId
string
required

The ID of the account to work with.

Example:

"F50091"

​
limit
integer
default:100

The maximum number of results to return.

Required range: 1 <= x <= 100000
Example:

100

​
offset
integer
default:0

The number of items to skip before returning results.

Example:

100

​
search
string

The term to search the records for.

Maximum string length: 100
Example:

"Cesar+Treutel"

​
status
enum<string>

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

Available options:
active,
deactivated,
created,
invited,
inviteExpired
Example:

"active,deactivated"

​
teams

Filter people by team.

​
addresses

Filter people by address.

​
roles

Filter people by role.

​
roleNames

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

Example:

"owner,admin"

​
people

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

​
budgetId

The list of IDs of the Budgets to work with

​
withoutIndividualBudget
enum<string>

Filter people without an individual budget.

Available options:
true,
false
​
include
enum<string>

Optional embeds to include when returning people.

Available options:
persona.addresses,
persona.createdBy,
persona.teams,
persona.primaryOwnerOf,
persona.roles,
address
Example:

"persona.addresses"

​
canBeIssuedIndividualCard
enum<string>

If true, the endpoint returns only people who can be issued an individual card.

Available options:
true,
false

Response

200 - application/json

OK

​
count
integer
required

The total amount of records matching the querying when "limit" is ignored.

Example:

67

​
rows
object[]
required

Array of all matching people.

​
limit
integer
default:100

The maximum number of results to return.

Required range: 1 <= x <= 1000
Example:

200

​
offset
integer
default:0

The number of items to skip before returning results.

Example:

100