Perfex CRM API Filtering, Sorting, and Pagination Guide

The Data Builder REST API for Perfex CRM provides high-performance data querying with robust filtering, multi-field sorting, cursor-based pagination, sparse fieldsets, and automated timestamp polling for seamless integration with automation platforms.

Query Parameters Overview

Data Builder REST API supports six query parameter types for precise data retrieval:

Filtering Data

Filter records by specific column values using the filter parameter. You can combine multiple filters in a single request:

# Filter clients by country
GET https://databuilder.polyxgo.com/api/v1/clients?filter=country:243

# Multiple filters combined
GET https://databuilder.polyxgo.com/api/v1/invoices?filter=status:2&filter=currency:1

Sorting Results

Sort results by any column in ascending or descending order. Prefix a column with a hyphen - to sort descending:

# Sort by newest first (descending by ID)
GET https://databuilder.polyxgo.com/api/v1/invoices?sort=-id

# Sort by creation date ascending
GET https://databuilder.polyxgo.com/api/v1/tasks?sort=dateadded

Sparse Fieldsets

Reduce payload size and boost response speed by specifying only the columns your application requires:

# Return only specific fields
GET https://databuilder.polyxgo.com/api/v1/clients?fields=userid,company,phonenumber,email

Pagination and Navigation

Paginated responses include HATEOAS navigation links and metadata to help your client traverse through large datasets:

{
  "data": [...],
  "meta": { 
    "current_page": 1, 
    "per_page": 25, 
    "total": 150 
  },
  "links": {
    "next": "/api/v1/clients?page=2&per_page=25",
    "prev": null
  }
}

Real-Time Polling with Since Parameter

For automation platforms, use the since parameter to fetch only records created or modified after a specific ISO-8601 timestamp:

# Get invoices modified in the last hour
GET https://databuilder.polyxgo.com/api/v1/invoices?since=2026-04-26T11:00:00

The engine auto-detects Perfex CRM timestamp columns (dateadded, datecreated, etc.) and returns results sorted newest-first. This enables reliable polling triggers for Zapier, Make.com, and n8n workflows.