Get a user by ID

GET /v1/users/{userID}
Organization service token

Returns information about the user with the specified ID.

Headers

Path parameters

  • userID string Required

    User ID

    Minimum length is 1.

Responses

  • 200 application/json

    User entity

    Hide response attributes Show response attributes object
    • name string

      The name of the user

    • email string(email)

      The email address

    • id string Required

      The ID of the user

      Minimum length is 1.

    • linkedAccounts array[object]
      Hide linkedAccounts attributes Show linkedAccounts attributes object
      • accountID string Required

        The account ID

      • accountType string Required

        The account type

        Values are discord, telegram, or embed.
  • 404 application/json

    User not found

    Hide response attributes Show response attributes object
    • success boolean Required

      Indicates the status of the request

    • error string Required

      A text representation of the error

    • fingerprint string

      A unique identifier of the event, useful for reporting

    • request_id string Required

      A unique identifier of the request, useful for reporting
GET /v1/users/{userID} 
curl \
 --request GET 'https://api.sensay.io/v1/users/03db5651-cb61-4bdf-9ef0-89561f7c9c53' \
 --header "X-ORGANIZATION-SECRET: $API_KEY" \
 --header "X-API-Version: 2025-03-25"
Response examples (200) 
{
  "name": "John Doe",
  "email": "user@example.com",
  "id": "johndoe",
  "linkedAccounts": [
    {
      "accountID": "string",
      "accountType": "discord"
    }
  ]
}
Response examples (404) 
{
  "success": true,
  "error": "string",
  "fingerprint": "14fceadd84e74ec499afe9b0f7952d6b",
  "request_id": "xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab"
}