General Parameters

Searching

Query string parameters

  • q string - Search query.

Pagination

Query string parameters

  • per_page integer - How many correspondences to show per page. Max is 50.
  • page integer - Which page to show.

Sorting

Query string parameters

  • sort_by string - Different supported values will be listed at the reference.
  • sort_direction string
    • Can be asc or desc

Fields

Parameters

  • fields - array
    • fields.*.id - uuid
      • Required
      • Must be a valid field_id
    • fields.*.value - array, boolean, number or string
      • Required
      • Must pass the validation for fields.*.id if the field has validation
      • Must be array if fields.*.id has options
        • fields.*.value.* - uuid
          • Must be valid option_id for fields.*.id