Skip to main content
Marty API list endpoints follow a consistent request structure and commonly support pagination, searching, sorting, selection, and filtering through query parameters.

​
Pagination

Most list endpoints support pagination and a common set of optional query parameters.
  • page — Page number to retrieve. Starts at 1.
  • pageSize — Number of records to return per page. Maximum value is 250.
  • search — Search term used to filter the returned records.
  • sortColumn — Column used to sort the results.
  • sortDirection — Sort order for the results. Supported values:
    • Ascending — Sorts items in ascending order, for example A to Z or 1 to 10.
    • Descending — Sorts items in descending order, for example Z to A or 10 to 1.
  • selectedIds — Comma-separated list of resource IDs to include in the selected section of the response.
Example request
Pagination metadata is returned in the response together with the requested records.

​
Filtering

Some list endpoints support filtering by one or more conditions. Refer to the documentation for each resource to see which fields and filter operators are supported.

​
In and Nin

Use In to return records where a field matches any of the provided values. Use Nin to exclude records where a field matches any of the provided values. Multiple values are provided as a comma-separated list. Example:
In this example:
  • InvitedTests.Id[In] returns candidates invited to any of the specified tests.
  • SolvedTests.Id[Nin] excludes candidates who solved any of the specified tests.
Filtering can be combined with pagination, search, and sorting parameters in the same request when supported by the endpoint.