Sail

Get User

GET/users/{user_id}

Retrieves a single user by Sail user id. The response is PII-free. Use the Identity endpoint for contact data.

Path Parameters

user_idstringrequired

The Sail user id.

Response

User details.

idstring

The Sail user id.

external_user_idstring

Echo of the external_user_id supplied at creation.

status"active" | "inactive"

Whether the user is active or inactive.

created_atstring<date-time>

When the user was created.

Standard error envelope covering 400, 401, 403, 404, 429, and 500.

errorobject

The error detail.

Show error properties
codestring

Machine-readable code, e.g. not_found, token_scope_mismatch, product_not_enabled, insufficient_key_scope, insufficient_token_scope, user_token_required, user_token_expired, invalid_user_token, invalid_key_configuration, connection_not_reconnectable, rate_limited.

messagestring

Human-readable error message. May change, so match on error.code instead.

paramstring

The request field that caused the error, when applicable. Null otherwise.

Request
curl -X GET "https://live.savewithsail.com/api/v1/users/<user_id>" \
  -H "Authorization: Bearer <token>"
Response
{
  "id": "usr_abc123",
  "external_user_id": "string",
  "status": "active",
  "created_at": "1970-01-01T00:00:00.000Z"
}