Pagination and filtering

Page, scope, filter, and sort parameters on list endpoints.

Pagination

Company and opportunity lists are paginated:

The response includes rows, total (the filtered total), page, and pages:

{ "ok": true, "rows": [ … ], "total": 21, "page": 1, "pages": 3 }

To fetch every record, increment page until it reaches pages:

def all_companies(session):
    page = 1
    while True:
        j = session.get("https://ornek.solk.app/api/v1/customers",
                        params={"scope": "all", "per": 100, "page": page}).json()
        yield from j["rows"]
        if page >= j["pages"]:
            break
        page += 1

People, action, fair lead, and email thread lists are not paginated; they return at most 300 records, all open actions, 300 records, and 100 records, respectively. Use filters to narrow the results.

Scope

Most lists accept scope:

Scope does not expand visibility: in an installation with team visibility enabled, scope=all returns only your own team's records. See Users and roles.

Filters and sorting

The q text search is case-insensitive and matches anywhere in the field.

Fetching changes

There is no separate "changes" endpoint. To sync:

• Fetch opportunities with sort=update and stop based on the last_update field.
• To learn about new and changed records immediately, use webhooks.