API to fetch user object by passing it’s unique distinct_id.
distinct_id
cURL
curl --request GET \ --url https://hub.suprsend.com/v1/user/{distinct_id}/ \ --header 'Authorization: Bearer <token>'
{ "distinct_id": "_distinct_id_", "properties": { "$locale": "en_GB", "$timezone": "America/New_York" }, "created_at": "2025-04-04T21:37:36.712496+00:00", "updated_at": "2025-04-04T21:37:36.743167+00:00", "$email": [ { "value": "[email protected]", "status": "active", "perma_status": "active" } ], "$inbox": [ { "value": "4nlPk4t4kurG5kChOELB8Q1LcDI9DHzHQ70st2E2C24", "id_provider": "suprsend", "status": "active", "perma_status": "active" } ] }
Pass as Bearer <API_KEY>. Get API Key from SuprSend dashboard Developers -> API Keys section.
Bearer <API_KEY>
Unique identifier of the user in your system
200
"_distinct_id_"
all user properties in key-value pair. SuprSend reserved properties start with $
"2025-04-04T09:55:12.397Z"
"2025-04-04T09:55:12.422Z"
Show child attributes
channel value
"active"
active/disabled. Perma_status is marked disabled in case of hard bounce on the channel.
Was this page helpful?