SimlaInstall

Summary

Retrieve customer records from the Simla API based on specified filters.

Inputs

• getFilter (required) — Filter the customers using various properties such as email, name, registration date, etc.
• limit — Specify the maximum number of records to return, with options for 20, 50, or 100.
• page — Specify the page number for pagination, default is 1.

Output shape

a list of customer records

Depends on the specified limit and pagination; returns an array of customer objects.

Examples

Example 1: Retrieve customers registered within a specific date range

{ "getFilter": [{ "key": "dateFrom", "value": "2023-01-01" }, { "key": "dateTo", "value": "2023-01-31" }], "limit": 50, "page": 1 }

Example 2: Get customers by email address

{ "getFilter": [{ "key": "email", "value": "example@example.com" }], "limit": 20, "page": 1 }