Client List API implementation guide (v2.1)
The client-list endpoint now supports three paging modes on the same resource. Existing legacy requests remain supported, while cursor and delta paging provide the recommended high-performance path for synchronisation integrations.
- Legacy offset paging — retained for backward compatibility and filtered, user-driven searches.
- Full cursor paging — recommended for retrieving every active client for a customer.
- Delta paging — recommended after the initial full sync; returns subsequent changes and deletion tombstones.
For a synchronisation integration: run one full cursor traversal, capture its UTC start time, run delta from that time to collect changes made during the full traversal, then continue polling with delta and a safely committed UTC watermark. Keep legacy paging only for workflows that need client search filters.
Endpoint and environments
GET /API/Core/v2.1/client/
| Environment | Endpoint |
|---|---|
| Sandbox | https://sandbox.coreplus.com.au/API/Core/v2.1/client/ |
| Production | https://api.coreplus.com.au/API/Core/v2.1/client/ |
Use HTTPS and keep consumer credentials and JWT generation in server-side code. Do not expose them in browser or mobile applications.
Authentication: sign the exact request URL
Authorization: JwToken <signed-jwt>
content-type: application/json
Use the existing coreplus HS256 JWT scheme and include the standard claims such as consumerId, accessToken, url, httpMethod, iss, aud, nbf and exp. Retain the issuer and audience values supplied during onboarding or already used by your working integration.
The JWT url claim must match the final request URL, including its encoded query string. Because a cursor changes the URL on every page, generate a fresh short-lived JWT for every page and retry:
- Build the complete URL with final, URL-encoded query parameters.
- Put that exact URL in the JWT
urlclaim and sethttpMethodtoGET. - Sign a new short-lived JWT.
- Send the already-built URL without changing its parameter order or encoding.
This applies to opaque cursor values, repeated Field parameters, an empty after= parameter, and retries after Retry-After. Never log JWTs, secrets, access tokens, cursor values or client payloads.
Choose the correct paging mode
| Mode | First request | Continuation | Use it for |
|---|---|---|---|
| Legacy offset | pageNumber=1&pageSize=100 |
Increment pageNumber |
Filtered searches, interactive lists and compatibility |
| Full cursor | after=&take=100 |
cursor=<nextCursor>&take=100 |
Complete active-client synchronisation |
| Delta | modifiedSince=<UTC>&take=100 |
cursor=<nextCursor>&take=100 |
Incremental updates and deletions |
Parameter presence selects the mode: cursor selects continuation, modifiedSince starts delta, and after starts full cursor paging. Without those parameters, the endpoint uses legacy paging. Do not mix paging modes or combine search filters with cursor/delta paging. Field is response selection and is supported in all modes.
Old and new requests
| Operation | Legacy request | Recommended request |
|---|---|---|
| Full retrieval, first page | ?pageNumber=1&pageSize=100 |
?after=&take=100 |
| Full retrieval, continuation | ?pageNumber=2&pageSize=100 |
?cursor=<nextCursor>&take=100 |
| Incremental retrieval | ?updatedSince=2026-10-01T00%3A00%3A00Z&pageNumber=1&pageSize=100 |
?modifiedSince=2026-10-01T00%3A00%3A00Z&take=100 |
Legacy responses use clients, paging and statusMessages. Cursor/delta responses use clients, nextCursor, count and totalCount. Cursor ordering differs from legacy alphabetical ordering, so validate migrations by comparing complete sets of clientId values after both traversals finish—not individual pages.
Legacy offset paging and filtered search
Legacy paging remains supported and is the correct mode for filtered searches:
GET https://api.coreplus.com.au/API/Core/v2.1/client/?pageNumber=1&pageSize=100
{
"clients": [{
"clientId": "<client-guid>",
"firstName": "Example",
"lastName": "Client",
"dateOfBirth": "1990-01-01T00:00:00"
}],
"paging": {"totalRows": 1, "pageNumber": 1, "pageSize": 100},
"statusMessages": []
}
The default pageSize is 50 and the maximum is 100. Existing search parameters such as name, DateOfBirth, mobile, email and medicare remain on legacy offset requests:
GET https://api.coreplus.com.au/API/Core/v2.1/client/?name=Example&mobile=0400000000&pageNumber=1&pageSize=50
The existing updatedSince parameter also remains in legacy mode and returns the legacy response envelope. It does not provide deletion tombstones. New polling integrations should use delta paging.