API Documentation
GET /persons
List all Persons objects you have added in your profile.
Headers
| NAME |
VALUE |
| Authorization |
Bearer {token} |
Query Parameters
| NAME |
VALUE |
| limit |
int. Maximum number of results returned. Default 100. |
| offset |
int. Used to paginate the results. Default 0. |
| email |
string. If provided will return an array with one object that matches the email, or an empty array. |
Response
| NAME |
VALUE |
| persons |
List of JSON objects. |
| persons[].id |
int. The ID of this person. |
| persons[].first_name |
string |
| persons[].last_name |
string |
| persons[].consent |
Deprecated: use ConsumerConsent instead. |
| persons[].email |
string. |
| persons[].last_opt_in |
Timestamp of when this person was added (YYYYMMDD) |
Status Code
| CODE |
COMMENT |
| 200 |
Request OK. |
| 401 |
User not authorized. |
