Skip to Content

Filtering

Filter Manufacturer API lists with RSQL, the date-time format and time zone, and the error a bad filter returns

List endpoints in the Manufacturer API take an optional filter query parameter. It uses RSQL, a query language for REST filters, so you fetch only the rows that you need.

This request returns the orders that changed on or after 16 October 2026:

curl -G https://m-api.eu.phas.io/api/manufacturer/v1/order \
  -H "Authorization: Bearer phasio_secret_token_here" \
  --data-urlencode "filter=updateDt=ge=2026-10-16T00:00:00"

URL-encode the whole filter value. Most HTTP clients do this for you, as curl --data-urlencode does above.

Comparison operators

A condition is a field name, an operator, and a value: status==ACTIVE. Field names are the property names in the endpoint's response.

OperatorDescription
==Equals
!=Does not equal
=gt=Greater than
=ge=Greater than or equal to
=lt=Less than
=le=Less than or equal to
=in=Equals any value in the list: status=in=(PAID,UNPAID)
=out=Equals no value in the list: status=out=(PAID,UNPAID)

Put a value that contains spaces or one of the operator characters in single or double quotes:

name=='Sample Project'

Logical operators

Combine conditions with ; for AND. All conditions must match:

status==ACTIVE;updateDt=ge=2026-10-16T00:00:00

Use , for OR. At least one condition must match:

status==PAID,status==UNPAID

Date-times

A date or date-time value is ISO 8601, in this form:

yyyy-MM-dd[THH:mm[:ss][.fraction]][zone]
  • The separator between date and time is T. A lowercase t also works, and so does a space, but a value with a space must be in quotes: updateDt=ge='2026-10-16 00:00:00'.
  • Seconds and the fraction are optional. A date without a time means midnight.
  • The zone is optional: Z, or an offset as +hh:mm, +hhmm, -hh:mm or -hhmm.

For example, 2026-10-16, 2026-10-16T00:00:00, 2026-10-16T09:30:15.250Z or 2026-10-16T11:30:15.250+02:00. Any other value, or a date that does not exist such as 2026-02-30, returns 400.

The API reads a date-time without a zone as UTC. updateDt=ge=2026-10-16T00:00:00 means midnight UTC.

A date-time with a zone means the moment it names. The API converts it to UTC before it compares, so updateDt=ge=2026-10-16T02:00:00+02:00, updateDt=ge=2026-10-16T00:00:00Z and updateDt=ge=2026-10-16T00:00:00 all mean midnight UTC.

URL-encode the + of an offset as %2B. An unencoded + arrives as a space and the filter returns INVALID_FILTER.

A field that holds a calendar date without a time, such as shipping.expectedDispatchDate on orders, compares only the date you write. The API ignores any time and zone on the value, so shipping.expectedDispatchDate==2026-10-16T01:00:00+02:00 matches 16 October.

Invalid filters

A filter that the API cannot read returns 400 Bad Request:

{
  "error": "INVALID_FILTER",
  "message": "A filter value is not valid for its field"
}

The message is The filter is not valid RSQL when the filter text itself cannot be parsed, for example an unbalanced bracket or quote.

The order list (GET /order) is the one exception for a value that is not valid for its field: it returns 400 with error ORDER_REQUEST_INVALID and message The order request is not valid. A filter it cannot parse still returns INVALID_FILTER. Every other list endpoint that takes a filter returns INVALID_FILTER in both cases.

Examples

Orders that changed in October 2026, for an incremental sync:

curl -G https://m-api.eu.phas.io/api/manufacturer/v1/order \
  -H "Authorization: Bearer phasio_secret_token_here" \
  --data-urlencode "filter=updateDt=ge=2026-10-01T00:00:00;updateDt=lt=2026-11-01T00:00:00"

The same orders, 50 at a time. A filter works with pagination:

curl -G https://m-api.eu.phas.io/api/manufacturer/v1/order \
  -H "Authorization: Bearer phasio_secret_token_here" \
  --data-urlencode "filter=updateDt=ge=2026-10-01T00:00:00;updateDt=lt=2026-11-01T00:00:00" \
  --data-urlencode "page=0" \
  --data-urlencode "size=50"

Last updated on

On this page