{ "opencollection": "1.0.0", "info": { "name": "Accounting subpackage_leads API", "version": "1.0.0" }, "items": [ { "info": { "name": "subpackage_leads", "type": "folder" }, "items": [ { "info": { "name": "List", "type": "http" }, "http": { "method": "GET", "url": "https://api.merge.dev/api/crm/v1/leads", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Account-Token", "value": "" } ], "params": [ { "name": "converted_account_id", "value": "", "type": "query", "description": "If provided, will only return leads with this account." }, { "name": "converted_contact_id", "value": "", "type": "query", "description": "If provided, will only return leads with this contact." }, { "name": "created_after", "value": "", "type": "query", "description": "If provided, will only return objects created after this datetime." }, { "name": "created_before", "value": "", "type": "query", "description": "If provided, will only return objects created before this datetime." }, { "name": "cursor", "value": "", "type": "query", "description": "The pagination cursor value." }, { "name": "email_addresses", "value": "", "type": "query", "description": "If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas." }, { "name": "expand", "value": "", "type": "query", "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces." }, { "name": "include_deleted_data", "value": "", "type": "query", "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)." }, { "name": "include_remote_data", "value": "", "type": "query", "description": "Whether to include the original data Merge fetched from the third-party to produce these models." }, { "name": "include_remote_fields", "value": "", "type": "query", "description": "Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format." }, { "name": "include_shell_data", "value": "", "type": "query", "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)." }, { "name": "modified_after", "value": "", "type": "query", "description": "If provided, only objects synced by Merge after this date time will be returned." }, { "name": "modified_before", "value": "", "type": "query", "description": "If provided, only objects synced by Merge before this date time will be returned." }, { "name": "owner_id", "value": "", "type": "query", "description": "If provided, will only return leads with this owner." }, { "name": "page_size", "value": "", "type": "query", "description": "Number of results to return per page. The maximum limit is 100." }, { "name": "phone_numbers", "value": "", "type": "query", "description": "If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas." }, { "name": "remote_id", "value": "", "type": "query", "description": "The API provider's ID for the given object." } ] }, "docs": "Returns a list of `Lead` objects.{/* BEGIN_CRM_LEAD_FETCH_SUPPORTED_FIELDS */}