SMsmileapi
Users

View User Session Payload

Changed on

Retrieve the payload data for a specific user session

get/users/{id}/payload

Request

  • Base URL
    https://sandbox.smileapi.io/v1
  • URL
    https://sandbox.smileapi.io/v1/users/{id}/payload
  • Auth
    HTTP basic

Path parameters

idstring required
Example:tenant-123abc456def789abc123def456abc78

The user ID

Response

User session payload retrieved successfully

code'OK' | 'CREATED' | 'INVALID_CREDENTIALS' | 'INVALID_PARAMETERS' | 'INVALID_TOKEN' | 'UNAUTHORIZED_ACCESS' | 'MISSING_RESOURCE' | 'REQUEST_LIMIT_EXCEEDED' | 'SERVER_ERROR' | 'UNSUPPORTED_METHOD' | 'SERVER_UNAVAILABLE' | 'TIME_LIMIT_EXCEEDED'

Request status code

requestIdstring

Unique ID that is added to the body of every response for easy traceability of the request in our logs.

messagestring

Message response to the request

Changes

  • v16ee094b51780Revision changes
    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

  • v12c7cb8512390Revision changes
    • info

      endpoint added