Querying

Every endpoint has a list operation that allows you to query for resources. The list operation supports various query parameters to filter, sort, and paginate the results. In the docs for each endpoint, you will find a section called Query Parameters that describes the available query parameters. Depending on the data type of a property you can use various operators to filter the results.

If you have a particular use case you are not sure how to implement, please reach out to us.

Date Operators

When a property needs to be exactly one date, you don't need to use any operator. You can simply pass the date as a string in ISO 8601 format, e.g., /v1/assignment-events?updatedAt=2025-01-01T00:00:00Z.

• $gt/$gte: If you need items that are after a certain date, use the $gt (greater than) or the $gte (greater then equal) operator. For example, /v1/assignment-events?updatedAt[$gt]=2025-01-01T00:00:00Z will return items that were updated after January 1, 2025.
• $lt/$lte: If you need items that are before a certain date, use the $lt (less than) or the $lte (less then equal) operator. For example, /v1/assignment-events?updatedAt[$lt]=2025-01-01T00:00:00Z will return items that were updated before January 1, 2025.
• $ne: If you need items that are not equal to a certain date, use the $ne (not equal) operator. For example, /v1/assignment-events?updatedAt[$ne]=2025-01-01T00:00:00Z will return items that were not updated on January 1, 2025.

You also can chain operators which will combine them to a logical AND. For example, /v1/assignment-events?updatedAt[$gt]=2025-01-01T00:00:00Z&updatedAt[$lt]=2025-01-02T00:00:00Z will return items that were updated on January 1, 2025.

Number Operators

When a property needs to be exactly one number, you don't need to use any operator. You can simply pass the number as a string, e.g., /v1/assignment-events?assignmentId=123.

• $in: If you need items that have a property with one of the given values, use the $in operator. For example, /v1/assignment-events?assignmentId[$in]=123,456,789 will return items that have an assignmentId of 123, 456, or 789.
• $nin: If you need items that have a property with none of the given values, use the $nin operator. For example, /v1/assignment-events?assignmentId[$nin]=123,456,789 will return items that have an assignmentId that is not 123, 456, or 789.
• $ne: If you need items that are not equal to a certain number, use the $ne (not equal) operator. For example, /v1/assignment-events?assignmentId[$ne]=123 will return items that do not have an assignmentId of 123.