Skip to main content

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.

​
Step 1: list all people

When an account is created, we automatically create a person using the details contained in the contact object. You can also add additional people using the API, which we’ll do in step 2. For now, let’s get a list of the people that are currently associated with your account. 
curl -i -X GET \
  'https://api-sandbox.equalsmoney.com/v2/people?accountId={accountId}' \
  -H 'Authorization: ApiKey {apiKey}' # Your API key
If your request is successful, you’ll receive a 200 response. In this example, we can see there are two people associated with this account. 
{
  "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"
      }
    }
  ]
}