> ## Documentation Index
> Fetch the complete documentation index at: https://docs.equalsmoney.com/llms.txt
> Use this file to discover all available pages before exploring further.
# List people
> View a list of people associated with an account.
## List people
**GET** `/v2/people`
### Request
Use this request to retrieve a list of people associated with a given account. The only required parameter is the `accountId`. You can use optional parameters to filter or search the results, and retrieve additional details.
```bash Sample request theme={null}
curl -i -X GET \
'https://api.equalsmoney.com/v2/people?accountId=F12345' \
-H 'Authorization: ApiKey YOUR_API_KEY_HERE'
```
```bash Request structure theme={null}
curl -i -X GET \
'https://api.equalsmoney.com/v2/people?accountId={accountId}' \
-H 'Authorization: ApiKey YOUR_API_KEY_HERE'
```
#### Query parameters
The ID of the account that you want to retrieve a list of people for.
Allowable values: An existing `accountId` (≤ 36 characters)
The maximum number of results to return. For example, `limit=25`. By default, this is set to `100`.
Allowable values: `[ 1 .. 100000 ]`
The number of items to skip before returning results. For example, `offset=200`. By default, this is set to `0`.
Allowable values: A valid integer
Filters results that include this string. For example, `search=Jane+Doe`.
Allowable values: A valid string
Optional embeds to include in the results. For example, `include=persona.addresses`.
Allowable values: `persona.addresses`, `persona.createdBy`, `persona.teams`, `persona.primaryOwnerOf`, `persona.roles`
Filters people by their status on the account. Use commas to pass multiple values. Has to be URL encoded. For example, `status=active%2Ccreated`.
Allowable values: `active`, `deactivated`, `created`, `invited`, `inviteExpired`
Filters people by their role ID. Use commas to pass multiple values. Has to be URL encoded. For example, `roles=02a42ec7-67d3-4fce-87b5-199080327ab9`.
Allowable values: A valid `roleId` (≤ 36 characters)
Filters people by their role name. Use commas to pass multiple values. Has to be URL encoded. For example, `roleNames=Admin`.
Allowable values: `Owner`, `Admin`, `Payer`, `Viewer`, `Accountant`, `User`
Filters people by their person ID. Use commas to pass multiple values. Has to be URL encoded. For example, `people=11e6ff45-c6b1-40c7-8551-46dd74536551`.
Allowable values: A valid `personId` (≤ 36 characters)
Filters people according to whether or not they have an individual budget. Set this to `true` to only return people who don't already have an individual budget associated with them.
Allowable values: `true`, `false`
The budget ID to filter results by.
Allowable values: An existing `budgetId` (≤ 36 characters)
### Response
If your request is successful, you'll receive a `200` response containing a list of people.
```json Sample response theme={null}
{
"count": 2,
"limit": 100,
"offset": 0,
"rows": [
{
"avatar": {
"url": "",
"fileName": ""
},
"id": "cfd2431d-a682-4167-adfa-5975bc47aaf5",
"productId": "d926625b-5e11-4ec1-b4cd-0af2a8021efc",
"sub": "7550a1c9-2c59-4c8d-a2a0-ffe8706adeaa",
"firstName": "Denis",
"lastName": "Desbois",
"title": null,
"middleInitials": null,
"dob": "1990-07-12",
"gender": null,
"nationality": null,
"countryOfResidence": null,
"status": "active",
"primaryMobileNumber": "+447700900639",
"primaryEmailAddress": "d.desbois@acme.com",
"createdAt": "2023-12-05T09:19:18.000Z",
"updatedAt": "2023-12-05T09:19:18.000Z",
"emailTheme": "em-light",
"persona": {
"id": "42a27839-7690-486c-8cf4-5084fab52494",
"emailAddress": "d.desbois@acme.com",
"employeeNumber": null,
"workNumber": null,
"status": "invited",
"jobTitle": null,
"createdByPersonaId": null,
"transactionalEmailPreference": false,
"cardTransactionPushNotificationPreference": true,
"createdAt": "2023-12-05T09:19:18.000Z",
"updatedAt": "2023-12-05T09:19:19.000Z",
"inviteSentDate": "2023-12-05T09:19:19.000Z"
}
},
{
"avatar": {
"url": "",
"fileName": ""
},
"id": "869bf05a-7818-491d-9670-c0470b29be46",
"productId": "d926625b-5e11-4ec1-b4cd-0af2a8021efc",
"sub": "ef5bf4c7-8f3f-4d26-ba13-4de1a4957ea3",
"firstName": "Patrick",
"lastName": "Parker",
"title": null,
"middleInitials": null,
"dob": "1980-08-05",
"gender": null,
"nationality": null,
"countryOfResidence": null,
"status": "active",
"primaryMobileNumber": "+4407700900330",
"primaryEmailAddress": "p.parker@acme.com",
"createdAt": "2024-01-01T14:00:38.000Z",
"updatedAt": "2024-01-01T14:00:39.000Z",
"emailTheme": "em-light",
"persona": {
"id": "4eac88a4-6bc1-4012-b182-863835f6afb9",
"emailAddress": "p.parker@acme.com",
"employeeNumber": null,
"workNumber": null,
"status": "invited",
"jobTitle": null,
"createdByPersonaId": null,
"transactionalEmailPreference": true,
"cardTransactionPushNotificationPreference": false,
"createdAt": "2024-01-01T14:00:39.000Z",
"updatedAt": "2024-01-01T14:00:39.000Z",
"inviteSentDate": "2024-01-01T14:00:39.000Z"
}
}
]
}
```
```json Response structure theme={null}
{
"count": integer,
"limit": integer,
"offset": integer,
"rows": [
{
"avatar": {
"url": "string",
"fileName": "string"
},
"id": "string",
"productId": "string",
"sub": "string",
"firstName": "string",
"lastName": "string",
"title": "string",
"middleInitials": "string",
"dob": "string",
"gender": "string",
"nationality": "string",
"countryOfResidence": "string",
"status": "string",
"primaryMobileNumber": "string",
"primaryEmailAddress": "string",
"createdAt": "string",
"updatedAt": "string",
"emailTheme": "string",
"persona": {
"id": "string",
"emailAddress": "string",
"employeeNumber": "string",
"workNumber": "string",
"status": "string",
"jobTitle": "string",
"createdByPersonaId": "string",
"transactionalEmailPreference": boolean,
"cardTransactionPushNotificationPreference": boolean,
"createdAt": "string",
"updatedAt": "string",
"inviteSentDate": "string"
}
}
]
}
```
For more detailed information about this request and its response, [see the API reference](/api-reference/people/list-people).