SalamCRMInstall

Summary

Retrieve a list of leads filtered by optional parameters such as status, provider ID, turn ID, operator ID, department ID, and a search query, with pagination support via skip and take parameters.

Inputs

• status — Filter leads by status (string).
• providerid — Filter leads by provider ID (number).
• turnid — Filter leads by turn ID (number).
• operatorid — Filter leads by operator ID (number).
• departmentid — Filter leads by department ID (number).
• query — Search query string to filter leads.
• skip — Number of leads to skip for pagination (number).
• take — Number of leads to retrieve for pagination (number).

Output shape

a list of lead objects matching the specified filters

Filters are applied via query parameters; numerical parameters default to zero and string parameters default to empty string if unset. If no filters are provided, all leads are returned (potentially paginated). Returned data is an array of JSON lead records.

Examples

Example 1: Retrieve all leads with status 'open' and limit to 10 records

Set 'status' to 'open' and 'take' to 10; other parameters left unset (default)