> ## Documentation Index > Fetch the complete documentation index at: https://docs.snagsolutions.io/llms.txt > Use this file to discover all available pages before exploring further. # Get loyalty currencies > Get loyalty currencies ## OpenAPI ````yaml /api-reference/openapi.documented.json get /api/loyalty/currencies openapi: 3.0.2 info: title: Snag Solutions - API Docs description: >- Documentation for Loyalty & Socials APIs. Some endpoints require an API key to authenticate. To obtain a key, reach out to the Snag Solutions team at support@snagsolutions.io. version: '0.1' servers: - url: https://admin.snagsolutions.io/ description: Production security: [] paths: /api/loyalty/currencies: get: tags: - Loyalty summary: Get loyalty currencies description: Get loyalty currencies parameters: - name: organizationId in: query description: Unique identifier for the organization required: true schema: type: string format: uuid title: Organization ID example: 123e4567-e89b-12d3-a456-426614174001 - name: websiteId in: query description: Unique identifier for the website required: true schema: type: string format: uuid title: Website ID example: 123e4567-e89b-12d3-a456-426614174002 - name: startingAfter in: query description: Cursor for pagination; start after this ID schema: type: string format: uuid title: Starting After example: 123e4567-e89b-12d3-a456-426614174010 - name: includeDeleted in: query description: Whether to include deleted currencies schema: type: string title: Include Deleted example: 'false' - name: excludeTokenRewardCurrencies in: query description: >- Exclude LoyaltyCurrency rows auto-created by token-reward rules (isTokenRewardCurrency=true). Defaults to true so admin pickers never see them; surfaces that need to render an existing token-reward rule pass false. schema: type: string title: Exclude Token Reward Currencies example: 'true' - name: limit in: query description: Maximum number of records to return schema: type: integer minimum: 1 maximum: 1000 title: Limit example: 50 responses: '200': description: '200' content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: string format: uuid title: ID description: Unique identifier for the loyalty currency example: 123e4567-e89b-12d3-a456-426614174005 organizationId: type: string format: uuid title: Organization ID description: Unique identifier for the organization example: 123e4567-e89b-12d3-a456-426614174001 websiteId: type: string format: uuid title: Website ID description: Unique identifier for the website example: 123e4567-e89b-12d3-a456-426614174002 imageUrl: type: string nullable: true title: Image URL description: URL of the image example: >- https://d1ked0nzx7in3u.cloudfront.net/images/loyalty.png name: type: string title: Name description: Name of the loyalty currency example: Loyalty Points symbol: type: string title: Symbol description: Symbol representing the loyalty currency example: LP decimals: type: number minimum: 0 title: Decimals description: Number of decimal places for the currency example: 2 createdById: type: string format: uuid nullable: true title: Created By ID description: ID of the user who created the currency example: 123e4567-e89b-12d3-a456-426614174010 createdAt: type: string format: date-time title: Created At description: Timestamp when the currency was created example: '2023-10-01T12:34:56.000Z' updatedAt: type: string format: date-time title: Updated At description: Timestamp when the currency was last updated example: '2023-10-05T15:30:00.000Z' apiGetUrl: type: string nullable: true title: API GET URL description: API GET URL for fetching data example: https://api.example.com/get-loyalty apiGetTransactionEntryUrl: type: string nullable: true title: API GET URL for transaction entries description: API GET URL for fetching transaction entry data example: https://api.example.com/get-loyalty apiPostUrl: type: string nullable: true title: API POST URL description: API POST URL for sending data example: https://api.example.com/post-loyalty apiAuthType: type: string enum: - none - basic - bearer - apiKey nullable: true title: API Auth Type description: Type of authentication used for API example: basic apiAuthKey: type: string nullable: true title: API Auth Key description: Authentication key for API example: apiKey123 apiAuthValue: type: string nullable: true title: API Auth Value description: Authentication value for API example: apiValue456 sortId: type: number nullable: true title: Sort ID description: Sorting identifier example: 1 deletedAt: type: string format: date-time nullable: true title: Deleted At description: >- Timestamp when the currency was deleted, if applicable example: null isTokenRewardCurrency: type: boolean title: Is Token Reward Currency description: >- True for LoyaltyCurrency rows auto-created by resolveTokenReward (Option 1 hidden currency backing a token-reward rule). Excluded from list responses by default; opt in via excludeTokenRewardCurrencies=false on the list endpoint. example: false required: - id - organizationId - websiteId - imageUrl - name - symbol - decimals - createdById - createdAt - updatedAt - apiGetUrl - apiGetTransactionEntryUrl - apiPostUrl - apiAuthType - apiAuthKey - apiAuthValue - sortId - deletedAt title: Loyalty Currency Schema description: Schema for a loyalty currency hasNextPage: type: boolean required: - data - hasNextPage '400': description: '400' content: application/json: schema: type: object properties: message: type: string title: Message description: Error message example: Request body is invalid required: - message title: Bad Request Response description: Schema for bad request response '403': description: '403' content: application/json: schema: type: object properties: message: type: string title: Message description: Error message example: Forbidden, Could not validate api key required: - message title: Forbidden Response description: Schema for forbidden response example: Forbidden, Could not validate api key '500': description: '500' content: application/json: schema: type: object properties: success: type: boolean title: Success description: Indicates operation success example: false message: type: string title: Message description: Error message example: Internal server error debugInfo: type: string title: Debug Info description: Optional debug information example: Stack trace or additional error details required: - success - message title: Internal Server Error Response description: Schema for internal server error response security: - apiKeyAuth: [] components: securitySchemes: apiKeyAuth: type: apiKey in: header name: X-API-KEY ````