Skip to main content
GET
/
v1
/
user
/
{distinct_id}
/
Fetch User by id
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": "john@example.com",
      "status": "active",
      "perma_status": "active"
    }
  ],
  "$inbox": [
    {
      "value": "4nlPk4t4kurG5kChOELB8Q1LcDI9DHzHQ70st2E2C24",
      "id_provider": "suprsend",
      "status": "active",
      "perma_status": "active"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Pass as Bearer <API_KEY>. Get API Key from SuprSend dashboard Developers -> API Keys section.

Path Parameters

​
distinct_id
string
required

Unique identifier of the user in your system

Response

200

​
distinct_id
string

Unique identifier of the user.

Example:

"_distinct_id_"

​
properties
object

all user properties in key-value pair. SuprSend reserved properties start with $

​
created_at
string<date-time>

Timestamp when the user was created.

Example:

"2025-04-04T09:55:12.397Z"

​
updated_at
string<date-time>

Timestamp when the user was last updated.

Example:

"2025-04-04T09:55:12.422Z"

​
$<channel>
object[]

List of active communication channels for the user.