Raw schema
{
"type": "object",
"properties": {
"free_text": {
"description": "Free-text query (name, phone, email…).",
"type": "string",
"maxLength": 500
},
"categories": {
"description": "Contact categories to include.",
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"enum": [
"patient",
"professional",
"clinic",
"unknown"
]
}
},
"tags": {
"description": "Contact tag text values (the `value` of a tag from sprucehealth_list_contact_tags).",
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"tags_match": {
"description": "How the tags combine: any (default), all, or none (exclude).",
"type": "string",
"enum": [
"any",
"all",
"none"
]
},
"given_name": {
"description": "Given (first) name.",
"type": "string",
"maxLength": 200
},
"family_name": {
"description": "Family (last) name.",
"type": "string",
"maxLength": 200
},
"phone_numbers": {
"description": "Phone numbers, e.g. 2065551234 or +12065551234.",
"maxItems": 20,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 40
}
},
"email_addresses": {
"description": "Email addresses.",
"maxItems": 20,
"type": "array",
"items": {
"type": "string",
"maxLength": 320,
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
}
},
"invite_states": {
"description": "Spruce account/invite state.",
"maxItems": 3,
"type": "array",
"items": {
"type": "string",
"enum": [
"has_account",
"invited",
"not_invited"
]
}
},
"created_from": {
"type": "string",
"description": "Only contacts added at or after this time (RFC 3339 with zone)."
},
"created_to": {
"type": "string",
"description": "Only contacts added at or before this time (RFC 3339 with zone)."
},
"page_size": {
"description": "Results per page (1-500). Keep it small (e.g. 25-50) for long records: an oversized page is cut, but the Paging part with the cursor always stays whole.",
"type": "integer",
"minimum": 1,
"maximum": 500
},
"pagination_token": {
"description": "The paginationToken from the previous page's reply (when hasMore is true).",
"type": "string",
"minLength": 1,
"maxLength": 4096
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}