{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/ringover/json-schema/ringover-contact-filter-schema.json",
  "title": "contact_filter",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/ringover-contacts-api-openapi.yml#/components/schemas/contact_filter",
  "type": "object",
  "properties": {
    "pagination": {
      "type": [
        "string",
        "null"
      ],
      "description": "[Deprecated] The character sequence assigned to pages in address book. Possible values are: 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '#' for any digit and '.' for any other characters. An empty value disables pagination. The pagination is based on the lastname by default, you can paginate by firstname or company name by combining the 'pagination' and 'alphabetical_order' fields."
    },
    "alphabetical_order": {
      "description": "[Deprecated] Alphabetical order impacts the pagination value. Possible values are : FirstnameLastnameCompanyDESC, FirstnameLastnameCompanyASC, LastnameFirstnameCompanyDESC, LastnameFirstnameCompanyASC, CompanyFirstnameLastnameDESC, CompanyFirstnameLastnameASC ,CompanyLastnameFirstnameDESC, CompanyLastnameFirstnameASC.\nValues all respect the format 'Field1Field2Field3ORDER' where 'Field1' will be the field the pagination is based on and 'ORDER' the order of the result (Ascending or Descending)\n",
      "type": [
        "string",
        "null"
      ]
    },
    "search": {
      "type": [
        "string",
        "null"
      ],
      "description": "The keyword is used to search a specific contact. Index is based on firstname, lastname, company and phone number(s)."
    },
    "limit_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Maximum number of results to return per page. Used for pagination. Maximum: 500.",
      "format": "int64",
      "maximum": 500
    },
    "limit_offset": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Number of elements that will be ignored, used to create a pagination cursor",
      "format": "int64"
    }
  }
}