API parameters

API parameters make developers efficient when working with Pipeliner API. API parameters may vary from endpoint to endpoint.

Example

{{baseUrl}}/entities/Clients?
include-deleted=true&
first=-8971250&
last=-8971250&
before=true&after=true&
expand=expand=owner,sales_unit,account_relations.account&
order-by=order-by=created,-modified&
load-only=id,default_unit_id&
filter[emai][email protected]

List of Query parameters

Query parameter Name	Description	Endpoint Type
validation-level	Turn offs validation on API requests	*.Create, *.Update, *.Delete
after	Cursor, Used for Pagination of long lists. See pagination	*.List
before	Cursor, Used for Pagination of long lists. See pagination	*.List
expand	Expand related entity, to get immediate overview	*.List, *.Get
filter	Filter data from API	*List
filter-op	Filter operators for filtering data	*.List
first	Number of entities to return from beginning of the result set. Max: 100. Default: 30	*.List
include_deleted	Returns deleted data Default: False	*.Get, *.List
last	Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.	*.List
load-only	Loads only api_fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. Example: load-only=id,name,owner.id	*.List
order-by	Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon Example: order-by=created,-modified	*.List
rollback-method	Used in bulk updates/create, to rollback data that failed. 0 - rollback all, 1 - rollback only failed records. Default:0 See Bulk Update and Create	*.batchmethods

Validation

Query parameter: validation-level

Helps when a developer doesn´t want to create data inside Pipeliner valid for some reason.

When the business has many required fields on the Entities, you might want to skip the validation of those fields and populate only fields that you actually need.

Option	Description
0(default)	Validate each field on the entity. Without even specifying this parameter, this is the general behavior of API - all API requests are automatically validated
2	Validate only changed fields in the actual request
4	Validate only system fields Custom/User-defined fields are not validated. Read about fields
8	Allows to override readonly fields
16	Allows setting entity on the deleted relationship. Example: user, an account might be deleted

Example of Request

Using validation as query parameter. In this case example, the validation is skipped for options "4" and "16"

{{baseUrl}}/entities/Opportunities?validation-level=416

Example of invalid Data in Application

The Majority of Invalid entities in the application look normal, however, after updating the data the user will see the information about invalid data

(Before user update )This record skipped validation and it was created through API without required field "Primary Account name"

(After Update) User cannot save the record, because it is required. He needs to select Primary Account name

Expand

Expand related entity. Use api_names of related fields. You can use multiple values separated via ',' comma. If not used, the URI link will be returned instead. You can use '.' to expand nested entities as well.

Example: expand=owner,sales_unit,account_relations.account

{{baseUrl}}/entities/Pipelines?expand=steps

Expand parameter can be used also in case of custom lookup fields.

{{baseUrl}}/entities/Accounts?expand=cf_lookup_account_contact.object

Filter, Filter-op

Filter

Use the API name of the field in braces to filter by this field. To do the advanced filter, use with combination with filter-op parameter.

Example: filter[api-field-name]=Example

{{baseUrl}}/entities/Pipelines?expand=steps&filter[name]=Test Pipeline

Filter-op

Filter-op stands for filter operator. Below is the list of operators. You can combine several operators with filter[api-field-name] parameter

eq - equals
ieq - case insensitive equals, e.g. "example" will match "Example" as well as "eXAmple"
contains - partial match, e.g. "xampl" will match "example"
starts - matches which starts with string, e.g. "exam" will match "example"
ends - matches which ends with string, e.g. "ample" will match "example"
icontains - same as contains, but case insensitive
istarts - same as starts, but case insensitive
iends - same as end, but case insensitive
null - lookup for null values
empty - lookup for empty values (e.g. string == "", or "  ")
gt - greater than
gte - greater or equal than
lt - less than
lte - less or equal than

{{baseUrl}}/entities/Pipelines?expand=steps&filter-op[name]=contains&filter[name]=Test Pipeline&filter-op[id]=eq&filter[id]=90be8a83-bae8-401d-9e5e-c4564a986270