getAllLoyaltyPrograms
Retrieve all loyalty programs within the Mews MCP server, optionally filtered by IDs, names, activity states, or date ranges using this tool. Ideal for managing and analyzing enterprise loyalty programs efficiently.
Instructions
Returns all loyalty programs of the enterprise, optionally filtered by specific loyalty program identifiers or other filter parameters.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ActivityStates | No | Whether to return only active, only deleted or both records. | |
| ChainIds | No | Unique identifiers of the chain. If not specified, the operation returns data for all chains within scope of the Access Token. | |
| CreatedUtc | No | The time interval during which the program was created (max length 3 months) | |
| Limitation | No | Limitation on the quantity of data returned | |
| LoyaltyProgramIds | No | Unique identifiers of Loyalty programs. | |
| Names | No | Names of the loyalty programs. | |
| UpdatedUtc | No | The time interval during which the program was last updated (max length 3 months) |
Input Schema (JSON Schema)
{
"additionalProperties": false,
"properties": {
"ActivityStates": {
"description": "Whether to return only active, only deleted or both records.",
"items": {
"type": "string"
},
"type": "array"
},
"ChainIds": {
"description": "Unique identifiers of the chain. If not specified, the operation returns data for all chains within scope of the Access Token.",
"items": {
"type": "string"
},
"maxItems": 1000,
"type": "array"
},
"CreatedUtc": {
"description": "The time interval during which the program was created (max length 3 months)",
"properties": {
"EndUtc": {
"description": "End of creation date range (ISO 8601)",
"type": "string"
},
"StartUtc": {
"description": "Start of creation date range (ISO 8601)",
"type": "string"
}
},
"type": "object"
},
"Limitation": {
"description": "Limitation on the quantity of data returned",
"properties": {
"Count": {
"description": "Maximum number of loyalty programs to return",
"type": "number"
},
"Cursor": {
"description": "Pagination cursor for next page",
"type": "string"
}
},
"type": "object"
},
"LoyaltyProgramIds": {
"description": "Unique identifiers of Loyalty programs.",
"items": {
"type": "string"
},
"maxItems": 1000,
"type": "array"
},
"Names": {
"description": "Names of the loyalty programs.",
"items": {
"type": "string"
},
"maxItems": 1000,
"type": "array"
},
"UpdatedUtc": {
"description": "The time interval during which the program was last updated (max length 3 months)",
"properties": {
"EndUtc": {
"description": "End of update date range (ISO 8601)",
"type": "string"
},
"StartUtc": {
"description": "Start of update date range (ISO 8601)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}