get_suprsend_user
Retrieve a user's stored properties and channel identifiers by their distinct ID to verify or use recipient data.
Instructions
Get a SuprSend user's full state by distinct_id. Users are end recipients of notifications, identified by your application's user id.
When to use: the user references a recipient by id and you need their stored properties or channel identifiers.
When NOT to use:
For non-user entities (organizations, projects, vehicles) — use get_suprsend_object.
For preferences only — use get_suprsend_user_preferences.
For mailing-list / object subscriptions — use get_suprsend_user_list_subscriptions or get_suprsend_user_objects_subscriptions.
Returns: YAML with distinct_id, properties (custom fields like name, plan, lang), created_at, updated_at, and a channels array — each entry has the channel value, status, and perma_status (e.g., bounced, blocked, soft-bounced).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| distinct_id | Yes | The distinct_id of the user to get. | |
| workspace | No | SuprSend workspace to get the user from. |