Filtering

If you don't specify any filters to GET methods, you will get all the items available from that specific endpoint. If you want to check if some specific data is present in the database or want to filter the results with some metadata, you can specify these filters in URL parameters. Notation for the parameters are:
<lookup_key>.<field>=<value>



Query Parameters

You can include the following query parameters to filter data:
  • Fields: Use query parameters with field names and conditions. The format is <lookup_key>.<field>=<value>
  • Use extensions to Filter: The format is <lookup_key>.<field>__<extension>=<value>. For example, user.name__icontains=example filters data where the user's name field contains "example."
  • Valid Extensions:
  • __gt: Greater than
  • __gte: Greater than or equal to
  • __lt: Less than
  • __lte: Less than or equal to
  • __isnull: Is null (e.g., field__isnull=True)
  • __icontains: Case-insensitive containment (e.g., name__icontains=example)
  • __in: In a list of values (e.g., id__in=1,2,3)
  • __json: For JSON field filtering (only validates the first key)
  • Not Equal: For string values you can use not equal operator. The format is <lookup_key>.<field>!=<value>.

Complete example to try within your environment:
https://<your_environment>/customer-api/1.0/users/?user.first_name__icontains=toni