Get user by id

Rate limit: 8 requests per minute.

get/manager/loyalty/v1/{source}/user

Request

Base URL
https://partners.tryotter.com
Auth
OAuth 2
Authorization code/v1/auth/oauth2/authorize
Client credentials
Token URL/v1/auth/token
Scopesmanager.loyalty
TypeScript
https://skmtc.dev/cloudkitchens/apis/otter-api/docs/manager/loyalty/v1/:source/user/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

sourcestring required

Loyalty provider source

Example:css-loyalty

Query parameters

idstring required

User's id

Example:somestring

Headers

X-Store-Idstring required

The unique identifier of the store in your app. This ID, along with the Application ID, will be used to match the correct store when performing operations. It cannot be longer than 255 characters and must only contain printable ASCII characters. During on-boarding, this ID will be similar to onboarding:905bb725-b141-4a9b-832a-1f254f772c94 (where the UUID is the Internal Store ID). During off-boarding, this field will be filled with the last known Store ID, or with an empty string, in case none is found. In that case, please fall back to the provided internalStoreId (a.k.a. Sku-Sku ID).

Example:partner-store-unique-identifier

Response

Get user response.

Example response

{
  "userAccount": {
    "id": "somestring",
    "userFields": [
      {
        "key": "full_name",
        "value": "john doe"
      }
    ],
    "balances": [
      {
        "amount": 19.07,
        "type": "POINT"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.