Pipeliner CRM Cloud API

Searching records

This tutorial explains how you can fetch records using basic and advanced search criteria. In the Pipeliner CRM, records refer to entities, such as Leads, Contacts, Accounts, and Opportunities.

You can search records through the Pipeliner CRM user interface and set the filters to display the required records. The following screenshot displays the fields you can use to search the Leads record – Name, Contact, Account, and the Owner.

Note: Similarly, you can use relevant fields to search the other record types in the Pipeliner CRM user interface. Refer to Fields & Forms for details.

Record Search Filter

Once you have configured the filters, you can enable the columns you want to display in the Leads interface.

When using the Pipeliner APIs to fetch a record, you need to use the <record_name>.list endpoint and define the search criteria as query parameters by using relevant filters. For example, to fetch Leads that meet your search criteria, use the Leads.list endpoint and specify one of the following filters.

Note: Before you can use the Leads.list endpoint, ensure that you have the Service URL and Space ID details. To learn more about how to obtain the Service URL and Space ID details, see the About APIs tutorial.

  • Lead name
  • Contact name for that Lead
  • The Account linked with that Lead
  • Owner of the Lead

Note: You can specify various combinations of different filters for creating a specific record search using the Pipeliner CRM APIs. See query parameters list for more details.

The following table describes the filter parameters you can use for the basic and advanced record searches.

Parameter name Syntax Description
filter
filter[name]=Example
Value for this parameter is passed as an object. Use the name of the field in braces to filter.
filter-op
filter-op[name]=eq
Value for this parameter is passed as an object. You can use this parameter with filter operators to specify advanced record search. Supported filter operators are eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between.

Perform a basic search to fetch records

This use case explains how to perform a basic search operation for fetching Lead whose name matches the specified filter.

Endpoint name: Leads.list

This endpoint uses the GET method to list all the Leads. Use Lead name as the filter to search through the Leads list.

Request URL syntax
Copy to Clipboard
Example Request URL
Copy to Clipboard

Note: For identifying your service URL and space_id, refer to the About API tutorial.

Example Response
Copy to Clipboard
Status code

Success: true

How to do basic record search using Postman

Search records using lead name

Perform an advanced search to fetch records

This use case explains how you can perform an advanced search using filter operators for fetching Leads that match the specified search criteria.

Endpoint name: Leads.list

This endpoint uses the GET method to list all the Leads that match the advanced search criteria. In the advanced search function, you have to use one or more operator combinations as the parameter value to get the appropriate results. The following table describes the operators used in this example.

Parameter name Value Description
filter-op[name] Required. This is a string value. This filter operator filters the name value. To view the list of supported operators that you can use, refer to the filter-op description in Leads.list.
filter[name] Required. This is a string value. Filter to search for a specified name value.
filter-op[phone1] Required. This is a not-empty field, and it can be a string or integer value. This filter operator filters the fields that are not null and searches the string or integer values corresponding to the filter operator we use.

Request URL syntax
Copy to Clipboard
Example Request URL
Copy to Clipboard

Note: For identifying your service URL and space_id, refer to the About API tutorial.

Example Response
Copy to Clipboard
Status code

Success: true

How to do advanced record search using Postman

You can use Postman or any other API tool for performing advanced searching of records. The below screenshot explains the steps to send the request with the required parameters in the JSON format.

Advance Record Search