---
title: "Get enrollment config for a loyalty provider"
method: GET
path: "/manager/loyalty/v1/{source}/user/enrollment-config"
tags: ["manager_loyalty_endpoints"]
---

# Get enrollment config for a loyalty provider

`GET /manager/loyalty/v1/{source}/user/enrollment-config`

## Request

- Base URL: `https://partners.tryotter.com`
- URL: `https://partners.tryotter.com/manager/loyalty/v1/{source}/user/enrollment-config`
- Auth: OAuth 2
  - Authorization code: `/v1/auth/oauth2/authorize`
  - Client credentials
  - Token URL: `/v1/auth/token` scopes: `manager.loyalty`
- TypeScript: <https://skmtc.dev/cloudkitchens/apis/otter-api/docs/manager/loyalty/v1/:source/user/enrollment-config/get.ts> (a function with typed inputs; its response is checked against the schema)

Rate limit: 8 requests per minute.

## Path parameters

- `source` string, required: Loyalty provider source

## Headers

- `X-Store-Id` string, 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).

## Response `200`

Enrollment config for the loyalty provider.

- GetEnrollmentConfigResponse: Response body for GetEnrollmentConfig API call.
  - `enrollmentFields` EnrollmentField[]: The fields that can be passed into when creating a new loyalty user.
    - `key` string: The key of field, will be used in the Create User API.
    - `required` boolean: Whether this field is required when creating a user.
    - `type` 'TEXT' | 'NUMBER' | 'EMAIL' | 'PASSWORD' | 'PHONE' | 'DATE' | 'DATE_TIME' | 'URL' | 'FULL_NAME' | 'ADDRESS': The type of field, frontend can use type to decide which input to use. i.e. use a date picker for DATE type, use a text input for EMAIL/FULL_NAME type.
    - `label` string: This can be used as the field input's label on the frontend.

## Other responses

- `400`: The request is malformed.
- `401`: Invalid authorization.
- `403`: Authorization not valid for the requested resource.
- `422`: The request body is not valid.

---

[API](https://skmtc.dev/cloudkitchens/apis/otter-api.md) - [All operations](https://skmtc.dev/cloudkitchens/apis/otter-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cloudkitchens/apis/otter-api/revisions/4c868194a467?raw)