This article shows how to get every record, how to filter and sort a list, and how to find the IDs your software needs, such as a tag or an order status. You need your company's API credentials and some technical knowledge of APIs.
Before you start
API access must be switched on for your company, and you need the Client ID and Client Secret from Settings > API Access on the Assignar dashboard. See "How do I create API credentials on the dashboard?".
The full request and response details are in the Assignar API documentation at apidocs.assignar.com.
Why does the Assignar Public API only return 100 records?
List requests return one page of records, not the whole list. If a form has 450 results, the first request only returns the first page. To get the rest, request the next pages until you have them all (see below). There isn't a separate endpoint that returns everything at once.
Get every page of a list from the Assignar Public API
Add page and page_size to the request. page is the page number, starting at 1, and page_size is how many records each page has. Always add a sort, so the records stay in the same order from page to page and none are skipped or repeated:
GET /form-results?form_id=12&sort=id&page=1&page_size=100
GET /form-results?form_id=12&sort=id&page=2&page_size=100
GET /form-results?form_id=12&sort=id&page=3&page_size=100
Keep going until a page comes back with fewer records than page_size, or empty. Some lists, such as form results, also return a count of all the records that match your request, so you know how many pages to expect.
Filter a list in the Assignar Public API
To get only the records you need, add a field and its value to the request. You can filter on any top-level field of the record, and combine filters with &:
GET /orders?status_id=3&client_id=27
For other comparisons, add an operator to the field name with two underscores. For example:
· date_created__gte=2026-01-01: on or after 1 January 2026
· date_created__between=2026-01-01,2026-03-31: between two dates
· id__in=101,102,103: one of a list of values
· name__substring=kent: contains "kent"
The API documentation lists every operator under Advanced Filtering.
Sort a list and choose its fields
Sort: add sort with a field name, for example sort=date_created. Put a hyphen in front to sort newest or largest first (sort=-date_created). Separate several fields with commas.
Choose fields: add fields to only get the fields you need, for example fields=id,name. Smaller responses come back faster.
Find IDs in the Assignar Public API
When your software creates or updates a record, it often needs the ID of something else in Assignar, such as a tag, an order status or a client. Each of these has its own list you can request, for example:
tags: GET /tags/ (each tag's ID and colour)
order statuses: GET /order-statuses
order types: GET /order-types
clients: GET /clients/
projects: GET /projects/
leave types: GET /leave-types
user types and employment types: GET /user-types and GET /employment-types
When someone adds a new tag or status on the Assignar dashboard, request the list again to get its ID. You don't need to ask Assignar Support for it.
Use the Assignar Public API with Power BI or Excel
Power BI and Excel can read the Assignar Public API, but each request only returns one page. Set up your query to request each page in turn, as above, and combine them; otherwise, your report only shows the first page. Filter the request (for example: to one form or a date range), so you only bring in the records you need. If you're not sure how to build this, ask your IT team or a Power BI partner.
For reporting on Assignar data without the API, someone with an Insights Creator Licence can build reports in Insights and download them.
Why is my Assignar Public API list missing records?
You only requested the first page. Request the next pages until one comes back with fewer records than page_size.
Records are skipped or repeated between pages. Add a sort, such as sort=id, to every page request.
A filter is too narrow. Check the field name and value, and remove filters one at a time to find the one that's excluding records.
