Step 3: find a person
Now that we've created a person, let's try looking them up using their personId
. This is the id
field from the response to the creation request.
SandboxProduction
curl -i -X GET \
'https://api-sandbox.equalsmoney.com/v2/people?accountId={accountId}&people={personId}' \
-H 'Authorization: {apiKey}'
curl -i -X GET \
'https://api.equalsmoney.com/v2/people?accountId={accountId}&people={personId}' \
-H 'Authorization: {apiKey}'
If your response is successful, you'll receive a 200
response containing the details about that person.
{
"count": 1,
"limit": 100,
"offset": 0,
"rows": [
{
"avatar": {
"url": "",
"fileName": ""
},
"id": "ef6d922f-70d5-4433-835c-8c77fa40d814",
"productId": "d926625b-5e11-4ec1-b4cd-0af2a8021efc",
"sub": "2a5a39cf-fda0-4901-9372-3f9039a2ee94",
"firstName": "Alison",
"lastName": "Abraham",
"title": null,
"middleInitials": null,
"dob": null,
"gender": null,
"nationality": null,
"countryOfResidence": null,
"status": "active",
"primaryMobileNumber": null,
"primaryEmailAddress": "a.abraham@acme.com",
"createdAt": "2024-01-02T13:47:01.000Z",
"updatedAt": "2024-01-02T13:47:02.000Z",
"emailTheme": "em-light",
"persona": {
"id": "32684fcd-b4be-438a-88d2-ee9b5f3eecd3",
"emailAddress": "a.abraham@acme.com",
"employeeNumber": null,
"workNumber": null,
"status": "invited",
"jobTitle": null,
"createdByPersonaId": null,
"transactionalEmailPreference": true,
"cardTransactionPushNotificationPreference": false,
"createdAt": "2024-01-02T13:47:02.000Z",
"updatedAt": "2024-01-02T13:47:02.000Z",
"inviteSentDate": "2024-01-02T13:47:02.000Z"
}
}
]
}