Read Street.co.uk properties, applicants, viewings, tenancies, jobs; create enquiries, notes, tasks.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
WRITE: record a new inbound enquiry (a lead) in Street. Street matches the email address to an existing person or creates one, and the agency's own automations may then email or assign the lead. Street requires the enquiry to be tied to exactly one record: pass property_id, or sales_applicant_id, or lettings_applicant_id. Pass the same enquiry_identifier on a retry: Street then returns the existing enquiry instead of creating a duplicate. POST /enquiries.
The enquiry text.
The enquirer's email address.
Enquirer's UK postcode (stored only when a new person is created).
Branch UUID to route the enquiry to (street_list_branches).
Enquirer's last name.
Enquirer's first name.
Property UUID the enquiry is about (street_list_properties).
One or two words naming the origin, e.g. website (max 25 characters).
The enquirer has a property to let.
The enquirer asks for a viewing.
The enquirer has a property to sell.
Enquirer's telephone number.
The enquirer asks for a valuation.
Your own stable id for this enquiry, prefixed with your integration name. Makes a retry safe.
Sales applicant UUID the enquiry belongs to (street_list_sales_applicants).
Lettings applicant UUID the enquiry belongs to (street_list_lettings_applicants).
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
WRITE: record a new inbound enquiry (a lead) in Street. Street matches the email address to an existing person or creates one, and the agency's own automations may then email or assign the lead. Street requires the enquiry to be tied to exactly one record: pass property_id, or sales_applicant_id, or lettings_applicant_id. Pass the same enquiry_identifier on a retry: Street then returns the existing enquiry instead of creating a duplicate. POST /enquiries.
| Argument | Type | Description |
|---|---|---|
| message* | string | The enquiry text. |
| postcode | string | Enquirer's UK postcode (stored only when a new person is created). |
| branch_id | string | Branch UUID to route the enquiry to (street_list_branches). |
| last_name | string | Enquirer's last name. |
| first_name | string | Enquirer's first name. |
| property_id | string | Property UUID the enquiry is about (street_list_properties). |
| custom_source | string | One or two words naming the origin, e.g. website (max 25 characters). |
| email_address* | string | The enquirer's email address. |
| property_to_let | boolean | The enquirer has a property to let. |
| request_viewing | boolean | The enquirer asks for a viewing. |
| property_to_sell | boolean | The enquirer has a property to sell. |
| telephone_number | string | Enquirer's telephone number. |
| request_valuation | boolean | The enquirer asks for a valuation. |
| enquiry_identifier | string | Your own stable id for this enquiry, prefixed with your integration name. Makes a retry safe. |
| sales_applicant_id | string | Sales applicant UUID the enquiry belongs to (street_list_sales_applicants). |
| lettings_applicant_id | string | Lettings applicant UUID the enquiry belongs to (street_list_lettings_applicants). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"email_address",
"message"
],
"properties": {
"message": {
"type": "string",
"maxLength": 5000,
"minLength": 1,
"description": "The enquiry text."
},
"postcode": {
"type": "string",
"maxLength": 8,
"minLength": 1,
"description": "Enquirer's UK postcode (stored only when a new person is created)."
},
"branch_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Branch UUID to route the enquiry to (street_list_branches)."
},
"last_name": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Enquirer's last name."
},
"first_name": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Enquirer's first name."
},
"property_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Property UUID the enquiry is about (street_list_properties)."
},
"custom_source": {
"type": "string",
"maxLength": 25,
"minLength": 1,
"description": "One or two words naming the origin, e.g. website (max 25 characters)."
},
"email_address": {
"type": "string",
"maxLength": 254,
"minLength": 3,
"description": "The enquirer's email address."
},
"property_to_let": {
"type": "boolean",
"description": "The enquirer has a property to let."
},
"request_viewing": {
"type": "boolean",
"description": "The enquirer asks for a viewing."
},
"property_to_sell": {
"type": "boolean",
"description": "The enquirer has a property to sell."
},
"telephone_number": {
"type": "string",
"maxLength": 30,
"minLength": 5,
"description": "Enquirer's telephone number."
},
"request_valuation": {
"type": "boolean",
"description": "The enquirer asks for a valuation."
},
"enquiry_identifier": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Your own stable id for this enquiry, prefixed with your integration name. Makes a retry safe."
},
"sales_applicant_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Sales applicant UUID the enquiry belongs to (street_list_sales_applicants)."
},
"lettings_applicant_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Lettings applicant UUID the enquiry belongs to (street_list_lettings_applicants)."
}
}
}WRITE: schedule a follow-up on a property, sales or lettings applicant, sale or valuation. Not idempotent: calling it twice creates two follow-ups. POST /follow-ups.
| Argument | Type | Description |
|---|---|---|
| note | string | What to follow up on. |
| due_date* | string | When the follow-up is due (yyyy-mm-dd). |
| target_id* | string | UUID of that record. |
| target_type* | string | The kind of record the follow-up belongs to. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"target_type",
"target_id",
"due_date"
],
"properties": {
"note": {
"type": "string",
"maxLength": 5000,
"minLength": 1,
"description": "What to follow up on."
},
"due_date": {
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
"description": "When the follow-up is due (yyyy-mm-dd)."
},
"target_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID of that record."
},
"target_type": {
"enum": [
"property",
"sales_applicant",
"lettings_applicant",
"sale",
"valuation"
],
"type": "string",
"description": "The kind of record the follow-up belongs to."
}
}
}WRITE: log a maintenance request against a property (a request, not a job: Street staff turn it into a job). Not idempotent: calling it twice logs two requests. POST /maintenance-requests.
| Argument | Type | Description |
|---|---|---|
| summary* | string | Short summary of the problem. |
| priority | string | Priority (default decided by Street). |
| description | string | Details of the problem. |
| property_id* | string | Property UUID (street_list_properties). |
| reported_at | string | When it was reported (default: now). |
| reported_by | string | Who reported it. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"property_id",
"summary"
],
"properties": {
"summary": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Short summary of the problem."
},
"priority": {
"enum": [
"low",
"medium",
"high",
"urgent",
"emergency"
],
"type": "string",
"description": "Priority (default decided by Street)."
},
"description": {
"type": "string",
"maxLength": 5000,
"minLength": 1,
"description": "Details of the problem."
},
"property_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Property UUID (street_list_properties)."
},
"reported_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "When it was reported (default: now)."
},
"reported_by": {
"enum": [
"tenant",
"landlord",
"agent",
"contractor"
],
"type": "string",
"description": "Who reported it."
}
}
}WRITE: add a note to one Street record (a person, property, applicant, sale, viewing, tenancy and so on). The note is visible to the agency's staff. Not idempotent: calling it twice adds two notes. POST /notes.
| Argument | Type | Description |
|---|---|---|
| body* | string | The note text. |
| pinned | boolean | Pin the note to the top. |
| author_id | string | UUID of the Street user to show as the author (street_list_users). Default: the token's user. |
| target_id* | string | UUID of that record. |
| target_type* | string | The kind of record the note goes on. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"target_type",
"target_id",
"body"
],
"properties": {
"body": {
"type": "string",
"maxLength": 10000,
"minLength": 1,
"description": "The note text."
},
"pinned": {
"type": "boolean",
"description": "Pin the note to the top."
},
"author_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID of the Street user to show as the author (street_list_users). Default: the token's user."
},
"target_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID of that record."
},
"target_type": {
"enum": [
"person",
"company",
"property",
"tenancy",
"sales_applicant",
"lettings_applicant",
"lettings_application",
"enquiry",
"owner",
"sale",
"sales_offer",
"lettings_offer",
"viewing",
"valuation",
"inspection",
"maintenance_job"
],
"type": "string",
"description": "The kind of record the note goes on."
}
}
}WRITE: create a task (to-do) in Street, optionally assigned to a user and given a task type. Not idempotent: calling it twice creates two tasks. POST /todos.
| Argument | Type | Description |
|---|---|---|
| body | string | Task description. |
| note | string | An extra note stored with the task. |
| title* | string | Task title. |
| user_id | string | UUID of the user to assign the task to (street_list_users). |
| due_date | string | Due date (yyyy-mm-dd). |
| task_type_id | string | Task type UUID (street_list_task_types). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"title"
],
"properties": {
"body": {
"type": "string",
"maxLength": 5000,
"minLength": 1,
"description": "Task description."
},
"note": {
"type": "string",
"maxLength": 5000,
"minLength": 1,
"description": "An extra note stored with the task."
},
"title": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Task title."
},
"user_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID of the user to assign the task to (street_list_users)."
},
"due_date": {
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
"description": "Due date (yyyy-mm-dd)."
},
"task_type_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Task type UUID (street_list_task_types)."
}
}
}One branch by UUID, with the related records you ask for in include. GET /branches/{id}.
| Argument | Type | Description |
|---|---|---|
| include | array | Related records to embed in "included". Allowed: users, properties, applicants. |
| branch_id* | string | Street branch UUID (from street_list_branches). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"branch_id"
],
"properties": {
"include": {
"type": "array",
"items": {
"enum": [
"users",
"properties",
"applicants"
],
"type": "string"
},
"maxItems": 3,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: users, properties, applicants."
},
"branch_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Street branch UUID (from street_list_branches)."
}
}
}One enquiry by UUID, with the related records you ask for in include. GET /enquiries/{id}.
| Argument | Type | Description |
|---|---|---|
| include | array | Related records to embed in "included". Allowed: property, branch, person. |
| enquiry_id* | string | Street enquiry UUID (from street_list_enquiries). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"enquiry_id"
],
"properties": {
"include": {
"type": "array",
"items": {
"enum": [
"property",
"branch",
"person"
],
"type": "string"
},
"maxItems": 3,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: property, branch, person."
},
"enquiry_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Street enquiry UUID (from street_list_enquiries)."
}
}
}One inspection by UUID, with the related records you ask for in include. GET /inspections/{id}.
| Argument | Type | Description |
|---|---|---|
| include | array | Related records to embed in "included". Allowed: property, inspector, bookedBy. |
| inspection_id* | string | Street inspection UUID (from street_list_inspections). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"inspection_id"
],
"properties": {
"include": {
"type": "array",
"items": {
"enum": [
"property",
"inspector",
"bookedBy"
],
"type": "string"
},
"maxItems": 3,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: property, inspector, bookedBy."
},
"inspection_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Street inspection UUID (from street_list_inspections)."
}
}
}One interested applicant by UUID, with the related records you ask for in include. GET /interested-applicants/{id}.
| Argument | Type | Description |
|---|---|---|
| include | array | Related records to embed in "included". Allowed: applicant, property. |
| interested_applicant_id* | string | Street interested applicant UUID (from street_list_interested_applicants). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"interested_applicant_id"
],
"properties": {
"include": {
"type": "array",
"items": {
"enum": [
"applicant",
"property"
],
"type": "string"
},
"maxItems": 2,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: applicant, property."
},
"interested_applicant_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Street interested applicant UUID (from street_list_interested_applicants)."
}
}
}One invoice by UUID, with the related records you ask for in include. GET /invoices/{id}.
| Argument | Type | Description |
|---|---|---|
| include | array | Related records to embed in "included". Allowed: property, owner, line_items. |
| invoice_id* | string | Street invoice UUID (from street_list_invoices). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"invoice_id"
],
"properties": {
"include": {
"type": "array",
"items": {
"enum": [
"property",
"owner",
"line_items"
],
"type": "string"
},
"maxItems": 3,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: property, owner, line_items."
},
"invoice_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Street invoice UUID (from street_list_invoices)."
}
}
}One landlord by UUID, with the related records you ask for in include. GET /landlords/{id}.
| Argument | Type | Description |
|---|---|---|
| include | array | Related records to embed in "included". Allowed: properties, properties.branch, notes. |
| landlord_id* | string | Street landlord UUID (from street_list_landlords). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"landlord_id"
],
"properties": {
"include": {
"type": "array",
"items": {
"enum": [
"properties",
"properties.branch",
"notes"
],
"type": "string"
},
"maxItems": 3,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: properties, properties.branch, notes."
},
"landlord_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Street landlord UUID (from street_list_landlords)."
}
}
}One lettings applicant by UUID, with the related records you ask for in include. GET /lettings-applicants/{id}.
| Argument | Type | Description |
|---|---|---|
| include | array | Related records to embed in "included". Allowed: branch, offers, viewings, people, company, notes, applications, followUp, negotiator. |
| lettings_applicant_id* | string | Street lettings applicant UUID (from street_list_lettings_applicants). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"lettings_applicant_id"
],
"properties": {
"include": {
"type": "array",
"items": {
"enum": [
"branch",
"offers",
"viewings",
"people",
"company",
"notes",
"applications",
"followUp",
"negotiator"
],
"type": "string"
},
"maxItems": 9,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: branch, offers, viewings, people, company, notes, applications, followUp, negotiator."
},
"lettings_applicant_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Street lettings applicant UUID (from street_list_lettings_applicants)."
}
}
}One lettings instruction by UUID, with the related records you ask for in include. GET /lettings-instructions/{id}.
| Argument | Type | Description |
|---|---|---|
| include | array | Related records to embed in "included". Allowed: property, owner, owner.people, valuation. |
| cancelled | string | with = also find it when cancelled. |
| lettings_instruction_id* | string | Street lettings instruction UUID (from street_list_lettings_instructions). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"lettings_instruction_id"
],
"properties": {
"include": {
"type": "array",
"items": {
"enum": [
"property",
"owner",
"owner.people",
"valuation"
],
"type": "string"
},
"maxItems": 4,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: property, owner, owner.people, valuation."
},
"cancelled": {
"enum": [
"with",
"only"
],
"type": "string",
"description": "with = also find it when cancelled."
},
"lettings_instruction_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Street lettings instruction UUID (from street_list_lettings_instructions)."
}
}
}One lettings offer by UUID, with the related records you ask for in include. GET /lettings-offers/{id}.
| Argument | Type | Description |
|---|---|---|
| include | array | Related records to embed in "included". Allowed: property, lettingsListing, applicant, applicant.people, branch, notes. |
| lettings_offer_id* | string | Street lettings offer UUID (from street_list_lettings_offers). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"lettings_offer_id"
],
"properties": {
"include": {
"type": "array",
"items": {
"enum": [
"property",
"lettingsListing",
"applicant",
"applicant.people",
"branch",
"notes"
],
"type": "string"
},
"maxItems": 6,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: property, lettingsListing, applicant, applicant.people, branch, notes."
},
"lettings_offer_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Street lettings offer UUID (from street_list_lettings_offers)."
}
}
}One maintenance job by UUID, with the related records you ask for in include. GET /maintenance-jobs/{id}.
| Argument | Type | Description |
|---|---|---|
| maintenance_job_id* | string | Street maintenance job UUID (from street_list_maintenance_jobs). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"maintenance_job_id"
],
"properties": {
"maintenance_job_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Street maintenance job UUID (from street_list_maintenance_jobs)."
}
}
}One person by UUID, with the related records you ask for in include. GET /people/{id}.
| Argument | Type | Description |
|---|---|---|
| include | array | Related records to embed in "included". Allowed: ownedProperties, applicants. |
| person_id* | string | Street person UUID (from street_list_people). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"person_id"
],
"properties": {
"include": {
"type": "array",
"items": {
"enum": [
"ownedProperties",
"applicants"
],
"type": "string"
},
"maxItems": 2,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: ownedProperties, applicants."
},
"person_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Street person UUID (from street_list_people)."
}
}
}One property by UUID, with the related records you ask for in include. GET /properties/{id}.
| Argument | Type | Description |
|---|---|---|
| include | array | Related records to embed in "included". Allowed: activeTenancy, branch, brochure, epc, floorplans, followUp, interestedApplicants, invoices, lettingsApplications, lettingsListing, lettingsOffers, media, negotiator, notes, outsideSpaces, owner, owner.company, owner.people, parking, propertyKeys, rooms, rooms.media, safetyCertificates, sales, salesListing, salesOffers, tenancies, valuations, viewings. |
| property_id* | string | Street property UUID (from street_list_properties). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"property_id"
],
"properties": {
"include": {
"type": "array",
"items": {
"enum": [
"activeTenancy",
"branch",
"brochure",
"epc",
"floorplans",
"followUp",
"interestedApplicants",
"invoices",
"lettingsApplications",
"lettingsListing",
"lettingsOffers",
"media",
"negotiator",
"notes",
"outsideSpaces",
"owner",
"owner.company",
"owner.people",
"parking",
"propertyKeys",
"rooms",
"rooms.media",
"safetyCertificates",
"sales",
"salesListing",
"salesOffers",
"tenancies",
"valuations",
"viewings"
],
"type": "string"
},
"maxItems": 29,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: activeTenancy, branch, brochure, epc, floorplans, followUp, interestedApplicants, invoices, lettingsApplications, lettingsListing, lettingsOffers, media, negotiator, notes, outsideSpaces, owner, owner.company, owner.people, parking, propertyKeys, rooms, rooms.media, safetyCertificates, sales, salesListing, salesOffers, tenancies, valuations, viewings."
},
"property_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Street property UUID (from street_list_properties)."
}
}
}One sale by UUID, with the related records you ask for in include. GET /sales/{id}.
| Argument | Type | Description |
|---|---|---|
| include | array | Related records to embed in "included". Allowed: property, applicant, applicant.people, vendor, vendor.people, branch, notes, buyerSolicitor, sellerSolicitor. |
| sale_id* | string | Street sale UUID (from street_list_sales). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"sale_id"
],
"properties": {
"include": {
"type": "array",
"items": {
"enum": [
"property",
"applicant",
"applicant.people",
"vendor",
"vendor.people",
"branch",
"notes",
"buyerSolicitor",
"sellerSolicitor"
],
"type": "string"
},
"maxItems": 9,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: property, applicant, applicant.people, vendor, vendor.people, branch, notes, buyerSolicitor, sellerSolicitor."
},
"sale_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Street sale UUID (from street_list_sales)."
}
}
}One sales applicant by UUID, with the related records you ask for in include. GET /sales-applicants/{id}.
| Argument | Type | Description |
|---|---|---|
| include | array | Related records to embed in "included". Allowed: branch, offers, viewings, people, company, notes, sales, followUp, negotiator. |
| sales_applicant_id* | string | Street sales applicant UUID (from street_list_sales_applicants). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"sales_applicant_id"
],
"properties": {
"include": {
"type": "array",
"items": {
"enum": [
"branch",
"offers",
"viewings",
"people",
"company",
"notes",
"sales",
"followUp",
"negotiator"
],
"type": "string"
},
"maxItems": 9,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: branch, offers, viewings, people, company, notes, sales, followUp, negotiator."
},
"sales_applicant_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Street sales applicant UUID (from street_list_sales_applicants)."
}
}
}One sales instruction by UUID, with the related records you ask for in include. GET /sales-instructions/{id}.
| Argument | Type | Description |
|---|---|---|
| include | array | Related records to embed in "included". Allowed: property, owner, owner.people, valuation, fees. |
| cancelled | string | with = also find it when cancelled. |
| sales_instruction_id* | string | Street sales instruction UUID (from street_list_sales_instructions). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"sales_instruction_id"
],
"properties": {
"include": {
"type": "array",
"items": {
"enum": [
"property",
"owner",
"owner.people",
"valuation",
"fees"
],
"type": "string"
},
"maxItems": 5,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: property, owner, owner.people, valuation, fees."
},
"cancelled": {
"enum": [
"with",
"only"
],
"type": "string",
"description": "with = also find it when cancelled."
},
"sales_instruction_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Street sales instruction UUID (from street_list_sales_instructions)."
}
}
}One sales offer by UUID, with the related records you ask for in include. GET /sales-offers/{id}.
| Argument | Type | Description |
|---|---|---|
| include | array | Related records to embed in "included". Allowed: property, applicant, applicant.people, branch, notes. |
| sales_offer_id* | string | Street sales offer UUID (from street_list_sales_offers). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"sales_offer_id"
],
"properties": {
"include": {
"type": "array",
"items": {
"enum": [
"property",
"applicant",
"applicant.people",
"branch",
"notes"
],
"type": "string"
},
"maxItems": 5,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: property, applicant, applicant.people, branch, notes."
},
"sales_offer_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Street sales offer UUID (from street_list_sales_offers)."
}
}
}One tenancy by UUID, with the related records you ask for in include. GET /tenancies/{id}.
| Argument | Type | Description |
|---|---|---|
| include | array | Related records to embed in "included". Allowed: property, property.owner, property.branch, owner, owner.people, tenants, guarantors, notes, inspections, epc, safetyCertificates, tenancyGuide, tenancyAgreement, landlordOfferLetter, tenantGuarantorReferenceForm, tenantGuarantorReferenceReport, tenantGuarantorIdDocument, generatedDocument, lettingsApplication. |
| tenancy_id* | string | Street tenancy UUID (from street_list_tenancies). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"tenancy_id"
],
"properties": {
"include": {
"type": "array",
"items": {
"enum": [
"property",
"property.owner",
"property.branch",
"owner",
"owner.people",
"tenants",
"guarantors",
"notes",
"inspections",
"epc",
"safetyCertificates",
"tenancyGuide",
"tenancyAgreement",
"landlordOfferLetter",
"tenantGuarantorReferenceForm",
"tenantGuarantorReferenceReport",
"tenantGuarantorIdDocument",
"generatedDocument",
"lettingsApplication"
],
"type": "string"
},
"maxItems": 19,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: property, property.owner, property.branch, owner, owner.people, tenants, guarantors, notes, inspections, epc, safetyCertificates, tenancyGuide, tenancyAgreement, landlordOfferLetter, tenantGuarantorReferenceForm, tenantGuarantorReferenceReport, tenantGuarantorIdDocument, generatedDocument, lettingsApplication."
},
"tenancy_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Street tenancy UUID (from street_list_tenancies)."
}
}
}One tenant by UUID, with the related records you ask for in include. GET /tenants/{id}.
| Argument | Type | Description |
|---|---|---|
| include | array | Related records to embed in "included". Allowed: tenancies, tenancies.property, tenancies.property.branch, notes. |
| tenant_id* | string | Street tenant UUID (from street_list_tenants). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"tenant_id"
],
"properties": {
"include": {
"type": "array",
"items": {
"enum": [
"tenancies",
"tenancies.property",
"tenancies.property.branch",
"notes"
],
"type": "string"
},
"maxItems": 4,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: tenancies, tenancies.property, tenancies.property.branch, notes."
},
"tenant_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Street tenant UUID (from street_list_tenants)."
}
}
}One user by UUID, with the related records you ask for in include. GET /users/{id}.
| Argument | Type | Description |
|---|---|---|
| include | array | Related records to embed in "included". Allowed: branch, ownedProperties, applicants. |
| user_id* | string | Street user UUID (from street_list_users). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"user_id"
],
"properties": {
"include": {
"type": "array",
"items": {
"enum": [
"branch",
"ownedProperties",
"applicants"
],
"type": "string"
},
"maxItems": 3,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: branch, ownedProperties, applicants."
},
"user_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Street user UUID (from street_list_users)."
}
}
}One valuation by UUID, with the related records you ask for in include. GET /valuations/{id}.
| Argument | Type | Description |
|---|---|---|
| include | array | Related records to embed in "included". Allowed: property, branch, notes, followUp, owner, owner.people, valuer, salesReport, lettingsReport, salesInstruction, lettingsInstruction, lostValuationDetail. |
| cancelled | string | with = also find it when cancelled. |
| valuation_id* | string | Street valuation UUID (from street_list_valuations). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"valuation_id"
],
"properties": {
"include": {
"type": "array",
"items": {
"enum": [
"property",
"branch",
"notes",
"followUp",
"owner",
"owner.people",
"valuer",
"salesReport",
"lettingsReport",
"salesInstruction",
"lettingsInstruction",
"lostValuationDetail"
],
"type": "string"
},
"maxItems": 12,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: property, branch, notes, followUp, owner, owner.people, valuer, salesReport, lettingsReport, salesInstruction, lettingsInstruction, lostValuationDetail."
},
"cancelled": {
"enum": [
"with",
"only"
],
"type": "string",
"description": "with = also find it when cancelled."
},
"valuation_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Street valuation UUID (from street_list_valuations)."
}
}
}One vendor by UUID, with the related records you ask for in include. GET /vendors/{id}.
| Argument | Type | Description |
|---|---|---|
| include | array | Related records to embed in "included". Allowed: properties, properties.branch, valuations, notes, negotiator. |
| vendor_id* | string | Street vendor UUID (from street_list_vendors). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"vendor_id"
],
"properties": {
"include": {
"type": "array",
"items": {
"enum": [
"properties",
"properties.branch",
"valuations",
"notes",
"negotiator"
],
"type": "string"
},
"maxItems": 5,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: properties, properties.branch, valuations, notes, negotiator."
},
"vendor_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Street vendor UUID (from street_list_vendors)."
}
}
}One viewing by UUID, with the related records you ask for in include. GET /viewings/{id}.
| Argument | Type | Description |
|---|---|---|
| include | array | Related records to embed in "included". Allowed: property, applicant, branch, notes, owner, owner.people, viewer, viewingFeedback. |
| cancelled | string | with = also find it when cancelled. |
| viewing_id* | string | Street viewing UUID (from street_list_viewings). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"viewing_id"
],
"properties": {
"include": {
"type": "array",
"items": {
"enum": [
"property",
"applicant",
"branch",
"notes",
"owner",
"owner.people",
"viewer",
"viewingFeedback"
],
"type": "string"
},
"maxItems": 8,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: property, applicant, branch, notes, owner, owner.people, viewer, viewingFeedback."
},
"cancelled": {
"enum": [
"with",
"only"
],
"type": "string",
"description": "with = also find it when cancelled."
},
"viewing_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Street viewing UUID (from street_list_viewings)."
}
}
}List areas (the area names used to match applicants and properties). Newest first as Street orders them; page with page and page_size. GET /areas.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| trashed | string | with = include deleted records, only = only deleted ones (default: not deleted). |
| page_size | integer | Results per page, 1-100 (default 25). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"trashed": {
"enum": [
"with",
"only"
],
"type": "string",
"description": "with = include deleted records, only = only deleted ones (default: not deleted)."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
}
}
}List branches (name, address, contact details). Newest first as Street orders them; page with page and page_size. GET /branches.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| include | array | Related records to embed in "included". Allowed: users, properties, applicants. |
| trashed | string | with = include deleted records, only = only deleted ones (default: not deleted). |
| page_size | integer | Results per page, 1-100 (default 25). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"include": {
"type": "array",
"items": {
"enum": [
"users",
"properties",
"applicants"
],
"type": "string"
},
"maxItems": 3,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: users, properties, applicants."
},
"trashed": {
"enum": [
"with",
"only"
],
"type": "string",
"description": "with = include deleted records, only = only deleted ones (default: not deleted)."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
}
}
}List enquiries (inbound leads: who, which property, message, source). Newest first as Street orders them; page with page and page_size. GET /enquiries.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| branch | string | Only enquiries of this branch (branch UUID, see street_list_branches). |
| trashed | string | with = include deleted records, only = only deleted ones (default: not deleted). |
| page_size | integer | Results per page, 1-100 (default 25). |
| created_to | string | Only records created before this date-time. |
| updated_to | string | Only records updated before this date-time. |
| created_from | string | Only records created after this date-time. |
| updated_from | string | Only records updated after this date-time (use it to sync changes). |
| email_address |
List follow-ups (due date, note, and the property, applicant, sale or valuation they belong to). Newest first as Street orders them; page with page and page_size. GET /follow-ups.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| branch | string | Only follow-ups of this branch (branch UUID, see street_list_branches). |
| include | array | Related records to embed in "included". Allowed: branch, negotiator, property, lettingsApplicant, salesApplicant, sale, valuation, viewing. |
| subject | array | Only records that relate to these kinds of record (property, lettingsApplicant, salesApplicant, sale, valuation, viewing). |
| trashed | string | with = include deleted records, only = only deleted ones (default: not deleted). |
| property | string | Only follow-ups of this property (UUID). |
| page_size | integer | Results per page, 1-100 (default 25). |
| created_to | string | Only records created before this date-time. |
List property inspections (due date, booked date, inspector, status). Newest first as Street orders them; page with page and page_size. GET /inspections.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| sort | string | Sort by due date, ascending or descending (-due_date). |
| status | array | Inspection statuses to include. |
| include | array | Related records to embed in "included". Allowed: property, inspector, bookedBy. |
| booked_to | string | Only inspections booked up to this date-time. |
| page_size | integer | Results per page, 1-100 (default 25). |
| booked_from | string | Only inspections booked from this date-time. |
| due_date_to | string | Only inspections due up to this date-time. |
| due_date_from | string |
List interested applicants (applicants who showed interest in a property). Newest first as Street orders them; page with page and page_size. GET /interested-applicants.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| include | array | Related records to embed in "included". Allowed: applicant, property. |
| property | string | Only applicants interested in this property (UUID). |
| page_size | integer | Results per page, 1-100 (default 25). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"include": {
"type": "array",
"items": {
"enum": [
"applicant",
"property"
],
"type": "string"
},
"maxItems": 2,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: applicant, property."
},
"property": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Only applicants interested in this property (UUID)."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
}
}
}List invoices (client accounting: property, owner, line items, paid and voided state). Newest first as Street orders them; page with page and page_size. GET /invoices.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| paid | boolean | true = paid invoices only, false = unpaid only. |
| voided | boolean | true = voided invoices only, false = not voided. |
| include | array | Related records to embed in "included". Allowed: property, owner, line_items. |
| page_size | integer | Results per page, 1-100 (default 25). |
| invoice_type | array | sales and/or lettings. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"paid": {
"type": "boolean",
"description": "true = paid invoices only, false = unpaid only."
},
"voided": {
"type": "boolean",
"description": "true = voided invoices only, false = not voided."
},
"include": {
"type": "array",
"items": {
"enum": [
"property",
"owner",
"line_items"
],
"type": "string"
},
"maxItems": 3,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: property, owner, line_items."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"invoice_type": {
"type": "array",
"items": {
"enum": [
"sales",
"lettings"
],
"type": "string"
},
"maxItems": 2,
"minItems": 1,
"description": "sales and/or lettings."
}
}
}List landlords (people letting a property). Newest first as Street orders them; page with page and page_size. GET /landlords.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| address | string | Fuzzy match on the full address text. |
| include | array | Related records to embed in "included". Allowed: properties, properties.branch, notes. |
| trashed | string | with = include deleted records, only = only deleted ones (default: not deleted). |
| page_size | integer | Results per page, 1-100 (default 25). |
| created_to | string | Only records created before this date-time. |
| updated_to | string | Only records updated before this date-time. |
| created_from | string | Only records created after this date-time. |
| updated_from | string |
List lettings applicants (prospective tenants: budget, bedrooms, areas, furnished, lead rating). Newest first as Street orders them; page with page and page_size. GET /lettings-applicants.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| areas | array | Area names (see street_list_areas). |
| branch | string | Only applicants of this branch (branch UUID, see street_list_branches). |
| include | array | Related records to embed in "included". Allowed: branch, offers, viewings, people, company, notes, applications, followUps, negotiator. |
| trashed | string | with = include deleted records, only = only deleted ones (default: not deleted). |
| price_to | integer | Maximum budget. |
| furnished | boolean | Only applicants who do (true) or do not (false) require furnished. |
| page_size | integer | Results per page, 1-100 (default 25). |
List lettings instructions (an agreement to let: property, owner). Newest first as Street orders them; page with page and page_size. GET /lettings-instructions.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| include | array | Related records to embed in "included". Allowed: property, owner, owner.people, valuation. |
| trashed | string | with = include deleted records, only = only deleted ones (default: not deleted). |
| page_size | integer | Results per page, 1-100 (default 25). |
| created_to | string | Only records created before this date-time. |
| updated_to | string | Only records updated before this date-time. |
| created_from | string | Only records created after this date-time. |
| updated_from | string | Only records updated after this date-time (use it to sync changes). |
List lettings offers (rent, applicant, property, status). Newest first as Street orders them; page with page and page_size. GET /lettings-offers.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| branch | string | Only offers of this branch (branch UUID, see street_list_branches). |
| status | array | Offer statuses to include. |
| include | array | Related records to embed in "included". Allowed: property, lettingsListing, applicant, applicant.people, branch, notes. |
| trashed | string | with = include deleted records, only = only deleted ones (default: not deleted). |
| page_size | integer | Results per page, 1-100 (default 25). |
| created_to | string | Only records created before this date-time. |
| updated_to | string | Only records updated before this date-time. |
| created_from |
List maintenance jobs (read-only: property, status, assignee, dates). Newest first as Street orders them; page with page and page_size. GET /maintenance-jobs.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| status | array | Job statuses to include. |
| include | array | Related records to embed in "included". Allowed: attachments, property, assignee. |
| trashed | string | with = include deleted records, only = only deleted ones (default: not deleted). |
| page_size | integer | Results per page, 1-100 (default 25). |
| created_to | string | Only records created before this date-time. |
| updated_to | string | Only records updated before this date-time. |
| reported_to | any | Only jobs reported before this date or date-time. |
| completed_to |
List people (contacts: name, emails, phones, addresses, contact preferences). Newest first as Street orders them; page with page and page_size. GET /people.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| address | string | Fuzzy match on the full address text. |
| include | array | Related records to embed in "included". Allowed: ownedProperties, applicants. |
| trashed | string | with = include deleted records, only = only deleted ones (default: not deleted). |
| page_size | integer | Results per page, 1-100 (default 25). |
| created_to | string | Only records created before this date-time. |
| updated_to | string | Only records updated before this date-time. |
| created_from | string | Only records created after this date-time. |
| updated_from | string |
List properties (sales and lettings listings, with address, status, price, bedrooms and the owner link). Newest first as Street orders them; page with page and page_size. GET /properties.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| tags | string | Agent-entered tag in lowercase; separate several with a semicolon for any of them. |
| branch | string | Only properties of this branch (branch UUID, see street_list_branches). |
| status | array | Property statuses to include. |
| address | string | Fuzzy match on the full address text. |
| include | array | Related records to embed in "included". Allowed: activeTenancy, branch, brochure, epc, floorplans, followUp, interestedApplicants, invoices, lettingsApplications, lettingsListing, lettingsOffers, media, negotiator, notes, outsideSpaces, owner, owner.company, owner.people, parking, propertyKeys, rooms, rooms.media, sales, salesListing, salesOffers, tenancies, valuations, viewings. |
| trashed | string | with = include deleted records, only = only deleted ones (default: not deleted). |
List sales (the sales progression records: agreed price, buyer, vendor, solicitors, status). Newest first as Street orders them; page with page and page_size. GET /sales.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| branch | string | Only sales of this branch (branch UUID, see street_list_branches). |
| status | array | Sale statuses to include. |
| include | array | Related records to embed in "included". Allowed: property, applicant, applicant.people, vendor, vendor.people, branch, notes, buyerSolicitor, sellerSolicitor. |
| trashed | string | with = include deleted records, only = only deleted ones (default: not deleted). |
| page_size | integer | Results per page, 1-100 (default 25). |
| created_to | string | Only records created before this date-time. |
| updated_to | string | Only records updated before this date-time. |
List sales applicants (buyers: budget, bedrooms, areas, buying and financial position, lead rating). Newest first as Street orders them; page with page and page_size. GET /sales-applicants.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| areas | array | Area names (see street_list_areas). |
| branch | string | Only applicants of this branch (branch UUID, see street_list_branches). |
| include | array | Related records to embed in "included". Allowed: branch, offers, viewings, people, company, notes, sales, followUps, negotiator. |
| trashed | string | with = include deleted records, only = only deleted ones (default: not deleted). |
| price_to | integer | Maximum budget. |
| page_size | integer | Results per page, 1-100 (default 25). |
| created_to | string | Only records created before this date-time. |
List sales instructions (an agreement to sell: property, owner, fees). Newest first as Street orders them; page with page and page_size. GET /sales-instructions.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| include | array | Related records to embed in "included". Allowed: property, owner, owner.people, valuation, fees. |
| trashed | string | with = include deleted records, only = only deleted ones (default: not deleted). |
| page_size | integer | Results per page, 1-100 (default 25). |
| created_to | string | Only records created before this date-time. |
| updated_to | string | Only records updated before this date-time. |
| created_from | string | Only records created after this date-time. |
| updated_from | string | Only records updated after this date-time (use it to sync changes). |
List sales offers (amount, applicant, property, status). Newest first as Street orders them; page with page and page_size. GET /sales-offers.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| branch | string | Only offers of this branch (branch UUID, see street_list_branches). |
| status | array | Offer statuses to include. |
| include | array | Related records to embed in "included". Allowed: property, salesListing, applicant, applicant.people, branch, notes. |
| trashed | string | with = include deleted records, only = only deleted ones (default: not deleted). |
| page_size | integer | Results per page, 1-100 (default 25). |
| created_to | string | Only records created before this date-time. |
| updated_to | string | Only records updated before this date-time. |
| created_from |
List task types (the categories a task can have; use an id as task_type_id when creating a task). Newest first as Street orders them; page with page and page_size. GET /todo-types.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| trashed | string | with = include deleted records, only = only deleted ones (default: not deleted). |
| page_size | integer | Results per page, 1-100 (default 25). |
| created_to | string | Only records created before this date-time. |
| updated_to | string | Only records updated before this date-time. |
| created_from | string | Only records created after this date-time. |
| updated_from | string | Only records updated after this date-time (use it to sync changes). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"trashed": {
"enum": [
"with",
"only"
],
"type": "string",
"description": "with = include deleted records, only = only deleted ones (default: not deleted)."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"created_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created before this date-time."
},
"updated_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated before this date-time."
},
"created_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created after this date-time."
},
"updated_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated after this date-time (use it to sync changes)."
}
}
}List tasks (to-dos with title, due date, assignee and the record they relate to). Newest first as Street orders them; page with page and page_size. GET /todos.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| branch | string | Only tasks of this branch (branch UUID, see street_list_branches). |
| include | array | Related records to embed in "included". Allowed: branch, negotiator, property, lettingsApplicant, salesApplicant, sale, valuation, viewing. |
| subject | array | Only records that relate to these kinds of record (property, lettingsApplicant, salesApplicant, sale, valuation, viewing). |
| trashed | string | with = include deleted records, only = only deleted ones (default: not deleted). |
| property | string | Only tasks of this property (UUID). |
| page_size | integer | Results per page, 1-100 (default 25). |
| created_to | string | Only records created before this date-time. |
List tenancies (property, tenants, owner, rent, dates). Newest first as Street orders them; page with page and page_size. GET /tenancies.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| include | array | Related records to embed in "included". Allowed: property, property.owner, property.branch, owner, owner.people, tenants, notes, inspections, lettingsApplication, guarantors. |
| trashed | string | with = include deleted records, only = only deleted ones (default: not deleted). |
| page_size | integer | Results per page, 1-100 (default 25). |
| created_to | string | Only records created before this date-time. |
| updated_to | string | Only records updated before this date-time. |
| created_from | string | Only records created after this date-time. |
| updated_from | string | Only records updated after this date-time (use it to sync changes). |
List tenants. Newest first as Street orders them; page with page and page_size. GET /tenants.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| address | string | Fuzzy match on the full address text. |
| include | array | Related records to embed in "included". Allowed: tenancies, tenancies.property, tenancies.property.branch, notes. |
| trashed | string | with = include deleted records, only = only deleted ones (default: not deleted). |
| page_size | integer | Results per page, 1-100 (default 25). |
| created_to | string | Only records created before this date-time. |
| updated_to | string | Only records updated before this date-time. |
| created_from | string | Only records created after this date-time. |
| updated_from | string |
List users (the agency's staff: name, job title, contact details, deactivated state). Newest first as Street orders them; page with page and page_size. GET /users.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| include | array | Related records to embed in "included". Allowed: branch. |
| trashed | string | with = include deleted records, only = only deleted ones (default: not deleted). |
| page_size | integer | Results per page, 1-100 (default 25). |
| created_to | string | Only records created before this date-time. |
| updated_to | string | Only records updated before this date-time. |
| created_from | string | Only records created after this date-time. |
| updated_from | string | Only records updated after this date-time (use it to sync changes). |
List valuations (market appraisals: property, valuer, time, status, outcome). Newest first as Street orders them; page with page and page_size. GET /valuations.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| type | string | sales or lettings. |
| branch | string | Only valuations of this branch (branch UUID, see street_list_branches). |
| status | array | Valuation statuses to include. |
| include | array | Related records to embed in "included". Allowed: property, branch, notes, followUp, owner, owner.people, valuer, salesReport, lettingsReport, salesInstruction, lettingsInstruction, lostValuationDetail. |
| trashed | string | with = include deleted records, only = only deleted ones (default: not deleted). |
| booked_to | string | Only those booked before this date-time. |
| cancelled | string | with = include cancelled ones, only = only cancelled ones (default: not cancelled). |
List vendors (people selling a property). Newest first as Street orders them; page with page and page_size. GET /vendors.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| address | string | Fuzzy match on the full address text. |
| include | array | Related records to embed in "included". Allowed: properties, properties.branch, valuations, notes, negotiator. |
| trashed | string | with = include deleted records, only = only deleted ones (default: not deleted). |
| page_size | integer | Results per page, 1-100 (default 25). |
| created_to | string | Only records created before this date-time. |
| updated_to | string | Only records updated before this date-time. |
| created_from | string | Only records created after this date-time. |
| updated_from | string |
List viewings (property, applicant, time, status, feedback). Newest first as Street orders them; page with page and page_size. GET /viewings.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| type | string | sales or lettings. |
| branch | string | Only viewings of this branch (branch UUID, see street_list_branches). |
| status | array | Viewing statuses to include. |
| include | array | Related records to embed in "included". Allowed: property, applicant, branch, notes, owner, owner.people, viewer, viewingFeedback. |
| trashed | string | with = include deleted records, only = only deleted ones (default: not deleted). |
| booked_to | string | Only those booked before this date-time. |
| cancelled | string | with = include cancelled ones, only = only cancelled ones (default: not cancelled). |
| page_size |
WRITE: change a person's title, name, marketing consent or contact preferences in Street. Street requires both names on every update, so the current record is read first and anything you leave out is sent back unchanged. Contact details (email, phone, address) cannot be changed through the API. PATCH /people/{id}.
| Argument | Type | Description |
|---|---|---|
| title | any | Title such as Mr, Mrs, Dr; null clears it. |
| last_name | string | New last name. |
| person_id* | string | Person UUID (street_list_people). |
| first_name | string | New first name. |
| contact_post | boolean | Contact preference: post. |
| contact_text | boolean | Contact preference: text message. |
| contact_email | boolean | Contact preference: email. |
| contact_phone | boolean | Contact preference: phone. |
| marketing_consent |
| string |
| Only records with this email address. |
| telephone_number | string | Telephone number in full international format, e.g. +441614960137. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"branch": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Only enquiries of this branch (branch UUID, see street_list_branches)."
},
"trashed": {
"enum": [
"with",
"only"
],
"type": "string",
"description": "with = include deleted records, only = only deleted ones (default: not deleted)."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"created_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created before this date-time."
},
"updated_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated before this date-time."
},
"created_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created after this date-time."
},
"updated_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated after this date-time (use it to sync changes)."
},
"email_address": {
"type": "string",
"maxLength": 254,
"minLength": 3,
"description": "Only records with this email address."
},
"telephone_number": {
"type": "string",
"pattern": "^\\+\\d{6,15}$",
"description": "Telephone number in full international format, e.g. +441614960137."
}
}
}| updated_to | string | Only records updated before this date-time. |
| created_from | string | Only records created after this date-time. |
| updated_from | string | Only records updated after this date-time (use it to sync changes). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"branch": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Only follow-ups of this branch (branch UUID, see street_list_branches)."
},
"include": {
"type": "array",
"items": {
"enum": [
"branch",
"negotiator",
"property",
"lettingsApplicant",
"salesApplicant",
"sale",
"valuation",
"viewing"
],
"type": "string"
},
"maxItems": 8,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: branch, negotiator, property, lettingsApplicant, salesApplicant, sale, valuation, viewing."
},
"subject": {
"type": "array",
"items": {
"enum": [
"property",
"lettingsApplicant",
"salesApplicant",
"sale",
"valuation",
"viewing"
],
"type": "string"
},
"maxItems": 6,
"minItems": 1,
"description": "Only records that relate to these kinds of record (property, lettingsApplicant, salesApplicant, sale, valuation, viewing)."
},
"trashed": {
"enum": [
"with",
"only"
],
"type": "string",
"description": "with = include deleted records, only = only deleted ones (default: not deleted)."
},
"property": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Only follow-ups of this property (UUID)."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"created_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created before this date-time."
},
"updated_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated before this date-time."
},
"created_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created after this date-time."
},
"updated_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated after this date-time (use it to sync changes)."
}
}
}| Only inspections due from this date-time. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"sort": {
"enum": [
"due_date",
"-due_date"
],
"type": "string",
"description": "Sort by due date, ascending or descending (-due_date)."
},
"status": {
"type": "array",
"items": {
"enum": [
"need_to_book",
"overdue",
"unconfirmed",
"booked",
"incomplete",
"complete",
"cancelled"
],
"type": "string"
},
"maxItems": 7,
"minItems": 1,
"description": "Inspection statuses to include."
},
"include": {
"type": "array",
"items": {
"enum": [
"property",
"inspector",
"bookedBy"
],
"type": "string"
},
"maxItems": 3,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: property, inspector, bookedBy."
},
"booked_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only inspections booked up to this date-time."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"booked_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only inspections booked from this date-time."
},
"due_date_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only inspections due up to this date-time."
},
"due_date_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only inspections due from this date-time."
}
}
}| Only records updated after this date-time (use it to sync changes). |
| email_address | string | Only records with this email address. |
| person_status | string | current or previous. |
| property_status | array | Only landlords whose property has one of these statuses. |
| telephone_number | string | Telephone number in full international format, e.g. +441614960137. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"address": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Fuzzy match on the full address text."
},
"include": {
"type": "array",
"items": {
"enum": [
"properties",
"properties.branch",
"notes"
],
"type": "string"
},
"maxItems": 3,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: properties, properties.branch, notes."
},
"trashed": {
"enum": [
"with",
"only"
],
"type": "string",
"description": "with = include deleted records, only = only deleted ones (default: not deleted)."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"created_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created before this date-time."
},
"updated_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated before this date-time."
},
"created_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created after this date-time."
},
"updated_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated after this date-time (use it to sync changes)."
},
"email_address": {
"type": "string",
"maxLength": 254,
"minLength": 3,
"description": "Only records with this email address."
},
"person_status": {
"enum": [
"current",
"previous"
],
"type": "string",
"description": "current or previous."
},
"property_status": {
"type": "array",
"items": {
"enum": [
"not_on_the_market",
"valuation_lost",
"valuation_booked",
"valuation_pending",
"valuation_cancelled",
"valuation_completed",
"instructed",
"let",
"to_let",
"let_agreed",
"for_sale_and_to_let",
"withdrawn_lettings",
"withdrawn_sales_and_lettings"
],
"type": "string"
},
"maxItems": 13,
"minItems": 1,
"description": "Only landlords whose property has one of these statuses."
},
"telephone_number": {
"type": "string",
"pattern": "^\\+\\d{6,15}$",
"description": "Telephone number in full international format, e.g. +441614960137."
}
}
}| created_to |
| string |
| Only records created before this date-time. |
| price_from | integer | Minimum budget. |
| updated_to | string | Only records updated before this date-time. |
| lead_rating | array | Lead ratings to include (hot, warm, cold). |
| created_from | string | Only records created after this date-time. |
| min_bedrooms | integer | Minimum bedrooms they need. |
| updated_from | string | Only records updated after this date-time (use it to sync changes). |
| follow_ups_due_to | string | Only applicants with a follow-up due before this date. |
| follow_ups_due_from | string | Only applicants with a follow-up due after this date. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"areas": {
"type": "array",
"items": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"maxItems": 30,
"minItems": 1,
"description": "Area names (see street_list_areas)."
},
"branch": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Only applicants of this branch (branch UUID, see street_list_branches)."
},
"include": {
"type": "array",
"items": {
"enum": [
"branch",
"offers",
"viewings",
"people",
"company",
"notes",
"applications",
"followUps",
"negotiator"
],
"type": "string"
},
"maxItems": 9,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: branch, offers, viewings, people, company, notes, applications, followUps, negotiator."
},
"trashed": {
"enum": [
"with",
"only"
],
"type": "string",
"description": "with = include deleted records, only = only deleted ones (default: not deleted)."
},
"price_to": {
"type": "integer",
"maximum": 1000000000,
"minimum": 0,
"description": "Maximum budget."
},
"furnished": {
"type": "boolean",
"description": "Only applicants who do (true) or do not (false) require furnished."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"created_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created before this date-time."
},
"price_from": {
"type": "integer",
"maximum": 1000000000,
"minimum": 0,
"description": "Minimum budget."
},
"updated_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated before this date-time."
},
"lead_rating": {
"type": "array",
"items": {
"enum": [
"hot",
"warm",
"cold"
],
"type": "string"
},
"maxItems": 3,
"minItems": 1,
"description": "Lead ratings to include (hot, warm, cold)."
},
"created_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created after this date-time."
},
"min_bedrooms": {
"type": "integer",
"maximum": 7,
"minimum": 1,
"description": "Minimum bedrooms they need."
},
"updated_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated after this date-time (use it to sync changes)."
},
"follow_ups_due_to": {
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
"description": "Only applicants with a follow-up due before this date."
},
"follow_ups_due_from": {
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
"description": "Only applicants with a follow-up due after this date."
}
}
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"include": {
"type": "array",
"items": {
"enum": [
"property",
"owner",
"owner.people",
"valuation"
],
"type": "string"
},
"maxItems": 4,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: property, owner, owner.people, valuation."
},
"trashed": {
"enum": [
"with",
"only"
],
"type": "string",
"description": "with = include deleted records, only = only deleted ones (default: not deleted)."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"created_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created before this date-time."
},
"updated_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated before this date-time."
},
"created_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created after this date-time."
},
"updated_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated after this date-time (use it to sync changes)."
}
}
}| string |
| Only records created after this date-time. |
| updated_from | string | Only records updated after this date-time (use it to sync changes). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"branch": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Only offers of this branch (branch UUID, see street_list_branches)."
},
"status": {
"type": "array",
"items": {
"enum": [
"pending",
"put_to_vendor",
"accepted",
"rejected"
],
"type": "string"
},
"maxItems": 4,
"minItems": 1,
"description": "Offer statuses to include."
},
"include": {
"type": "array",
"items": {
"enum": [
"property",
"lettingsListing",
"applicant",
"applicant.people",
"branch",
"notes"
],
"type": "string"
},
"maxItems": 6,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: property, lettingsListing, applicant, applicant.people, branch, notes."
},
"trashed": {
"enum": [
"with",
"only"
],
"type": "string",
"description": "with = include deleted records, only = only deleted ones (default: not deleted)."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"created_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created before this date-time."
},
"updated_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated before this date-time."
},
"created_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created after this date-time."
},
"updated_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated after this date-time (use it to sync changes)."
}
}
}| any |
| Only jobs completed before this date or date-time. |
| created_from | string | Only records created after this date-time. |
| updated_from | string | Only records updated after this date-time (use it to sync changes). |
| reported_from | any | Only jobs reported after this date or date-time. |
| completed_from | any | Only jobs completed after this date or date-time. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"status": {
"type": "array",
"items": {
"enum": [
"awaiting_instruction",
"awaiting_quote",
"awaiting_quote_approval",
"contractor_instructed",
"invoice_added",
"invoice_paid",
"job_cancelled",
"job_closed",
"job_complete",
"job_details_added"
],
"type": "string"
},
"maxItems": 10,
"minItems": 1,
"description": "Job statuses to include."
},
"include": {
"type": "array",
"items": {
"enum": [
"attachments",
"property",
"assignee"
],
"type": "string"
},
"maxItems": 3,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: attachments, property, assignee."
},
"trashed": {
"enum": [
"with",
"only"
],
"type": "string",
"description": "with = include deleted records, only = only deleted ones (default: not deleted)."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"created_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created before this date-time."
},
"updated_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated before this date-time."
},
"reported_to": {
"anyOf": [
{
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
"description": "A date, yyyy-mm-dd."
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "ISO 8601 date-time with a timezone, e.g. 2026-10-01T00:00:00Z."
}
],
"description": "Only jobs reported before this date or date-time."
},
"completed_to": {
"anyOf": [
{
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
"description": "A date, yyyy-mm-dd."
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "ISO 8601 date-time with a timezone, e.g. 2026-10-01T00:00:00Z."
}
],
"description": "Only jobs completed before this date or date-time."
},
"created_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created after this date-time."
},
"updated_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated after this date-time (use it to sync changes)."
},
"reported_from": {
"anyOf": [
{
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
"description": "A date, yyyy-mm-dd."
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "ISO 8601 date-time with a timezone, e.g. 2026-10-01T00:00:00Z."
}
],
"description": "Only jobs reported after this date or date-time."
},
"completed_from": {
"anyOf": [
{
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
"description": "A date, yyyy-mm-dd."
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "ISO 8601 date-time with a timezone, e.g. 2026-10-01T00:00:00Z."
}
],
"description": "Only jobs completed after this date or date-time."
}
}
}| Only records updated after this date-time (use it to sync changes). |
| email_address | string | Only records with this email address. |
| telephone_number | string | Telephone number in full international format, e.g. +441614960137. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"address": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Fuzzy match on the full address text."
},
"include": {
"type": "array",
"items": {
"enum": [
"ownedProperties",
"applicants"
],
"type": "string"
},
"maxItems": 2,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: ownedProperties, applicants."
},
"trashed": {
"enum": [
"with",
"only"
],
"type": "string",
"description": "with = include deleted records, only = only deleted ones (default: not deleted)."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"created_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created before this date-time."
},
"updated_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated before this date-time."
},
"created_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created after this date-time."
},
"updated_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated after this date-time (use it to sync changes)."
},
"email_address": {
"type": "string",
"maxLength": 254,
"minLength": 3,
"description": "Only records with this email address."
},
"telephone_number": {
"type": "string",
"pattern": "^\\+\\d{6,15}$",
"description": "Telephone number in full international format, e.g. +441614960137."
}
}
}| bedrooms | integer | Exact number of bedrooms. |
| category | string | sales or lettings. |
| postcode | string | First or partial postcode: M, M1 1JU or the sector M28 2. |
| page_size | integer | Results per page, 1-100 (default 25). |
| created_to | string | Only records created before this date-time. |
| updated_to | string | Only records updated before this date-time. |
| created_from | string | Only records created after this date-time. |
| min_bedrooms | integer | Minimum number of bedrooms. |
| updated_from | string | Only records updated after this date-time (use it to sync changes). |
| max_price_sales | integer | Maximum sales listing price. |
| min_price_sales | integer | Minimum sales listing price. |
| include_archived | boolean | Include archived properties. |
| max_price_lettings | integer | Maximum lettings listing price. |
| min_price_lettings | integer | Minimum lettings listing price. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"tags": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Agent-entered tag in lowercase; separate several with a semicolon for any of them."
},
"branch": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Only properties of this branch (branch UUID, see street_list_branches)."
},
"status": {
"type": "array",
"items": {
"enum": [
"not_on_the_market",
"valuation_lost",
"valuation_booked",
"valuation_pending",
"valuation_cancelled",
"provisional_valuation_booked",
"valuation_completed",
"instructed",
"for_sale",
"under_offer",
"sold_stc",
"exchanged",
"let",
"to_let",
"let_agreed",
"for_sale_and_to_let",
"withdrawn_sales",
"withdrawn_lettings",
"withdrawn_sales_and_lettings",
"completed",
"auction_completed"
],
"type": "string"
},
"maxItems": 21,
"minItems": 1,
"description": "Property statuses to include."
},
"address": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Fuzzy match on the full address text."
},
"include": {
"type": "array",
"items": {
"enum": [
"activeTenancy",
"branch",
"brochure",
"epc",
"floorplans",
"followUp",
"interestedApplicants",
"invoices",
"lettingsApplications",
"lettingsListing",
"lettingsOffers",
"media",
"negotiator",
"notes",
"outsideSpaces",
"owner",
"owner.company",
"owner.people",
"parking",
"propertyKeys",
"rooms",
"rooms.media",
"sales",
"salesListing",
"salesOffers",
"tenancies",
"valuations",
"viewings"
],
"type": "string"
},
"maxItems": 28,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: activeTenancy, branch, brochure, epc, floorplans, followUp, interestedApplicants, invoices, lettingsApplications, lettingsListing, lettingsOffers, media, negotiator, notes, outsideSpaces, owner, owner.company, owner.people, parking, propertyKeys, rooms, rooms.media, sales, salesListing, salesOffers, tenancies, valuations, viewings."
},
"trashed": {
"enum": [
"with",
"only"
],
"type": "string",
"description": "with = include deleted records, only = only deleted ones (default: not deleted)."
},
"bedrooms": {
"type": "integer",
"maximum": 30,
"minimum": 0,
"description": "Exact number of bedrooms."
},
"category": {
"enum": [
"sales",
"lettings"
],
"type": "string",
"description": "sales or lettings."
},
"postcode": {
"type": "string",
"maxLength": 8,
"minLength": 1,
"description": "First or partial postcode: M, M1 1JU or the sector M28 2."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"created_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created before this date-time."
},
"updated_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated before this date-time."
},
"created_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created after this date-time."
},
"min_bedrooms": {
"type": "integer",
"maximum": 30,
"minimum": 0,
"description": "Minimum number of bedrooms."
},
"updated_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated after this date-time (use it to sync changes)."
},
"max_price_sales": {
"type": "integer",
"maximum": 1000000000,
"minimum": 0,
"description": "Maximum sales listing price."
},
"min_price_sales": {
"type": "integer",
"maximum": 1000000000,
"minimum": 0,
"description": "Minimum sales listing price."
},
"include_archived": {
"type": "boolean",
"description": "Include archived properties."
},
"max_price_lettings": {
"type": "integer",
"maximum": 1000000000,
"minimum": 0,
"description": "Maximum lettings listing price."
},
"min_price_lettings": {
"type": "integer",
"maximum": 1000000000,
"minimum": 0,
"description": "Minimum lettings listing price."
}
}
}| created_from |
| string |
| Only records created after this date-time. |
| updated_from | string | Only records updated after this date-time (use it to sync changes). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"branch": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Only sales of this branch (branch UUID, see street_list_branches)."
},
"status": {
"type": "array",
"items": {
"enum": [
"completed",
"fallen_through",
"offer_accepted",
"exchanged",
"under_offer"
],
"type": "string"
},
"maxItems": 5,
"minItems": 1,
"description": "Sale statuses to include."
},
"include": {
"type": "array",
"items": {
"enum": [
"property",
"applicant",
"applicant.people",
"vendor",
"vendor.people",
"branch",
"notes",
"buyerSolicitor",
"sellerSolicitor"
],
"type": "string"
},
"maxItems": 9,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: property, applicant, applicant.people, vendor, vendor.people, branch, notes, buyerSolicitor, sellerSolicitor."
},
"trashed": {
"enum": [
"with",
"only"
],
"type": "string",
"description": "with = include deleted records, only = only deleted ones (default: not deleted)."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"created_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created before this date-time."
},
"updated_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated before this date-time."
},
"created_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created after this date-time."
},
"updated_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated after this date-time (use it to sync changes)."
}
}
}| price_from |
| integer |
| Minimum budget. |
| updated_to | string | Only records updated before this date-time. |
| lead_rating | array | Lead ratings to include (hot, warm, cold). |
| created_from | string | Only records created after this date-time. |
| min_bedrooms | integer | Minimum bedrooms they need. |
| updated_from | string | Only records updated after this date-time (use it to sync changes). |
| buying_position | array | Buying positions: FTB first-time buyer, INV investor, BTLI buy to let investor, NPTS no property to sell, NOM selling (valuation stage), OTM selling (on the market), SSTC selling (sold STC), UO selling (under offer), PTS property to sell, DEV developer, BUY buying agent. |
| follow_ups_due_to | string | Only applicants with a follow-up due before this date. |
| financial_position | array | Financial positions: NIP nothing in place, SOAQ seeking own advice or quotes, SAMA seeing the agent's mortgage advisor, AIP agreement in principle in place, NFCB cash buyer (needs no finance), CBFS cash buyer with proceeds from a sale, PMTG porting mortgage. |
| follow_ups_due_from | string | Only applicants with a follow-up due after this date. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"areas": {
"type": "array",
"items": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"maxItems": 30,
"minItems": 1,
"description": "Area names (see street_list_areas)."
},
"branch": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Only applicants of this branch (branch UUID, see street_list_branches)."
},
"include": {
"type": "array",
"items": {
"enum": [
"branch",
"offers",
"viewings",
"people",
"company",
"notes",
"sales",
"followUps",
"negotiator"
],
"type": "string"
},
"maxItems": 9,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: branch, offers, viewings, people, company, notes, sales, followUps, negotiator."
},
"trashed": {
"enum": [
"with",
"only"
],
"type": "string",
"description": "with = include deleted records, only = only deleted ones (default: not deleted)."
},
"price_to": {
"type": "integer",
"maximum": 1000000000,
"minimum": 0,
"description": "Maximum budget."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"created_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created before this date-time."
},
"price_from": {
"type": "integer",
"maximum": 1000000000,
"minimum": 0,
"description": "Minimum budget."
},
"updated_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated before this date-time."
},
"lead_rating": {
"type": "array",
"items": {
"enum": [
"hot",
"warm",
"cold"
],
"type": "string"
},
"maxItems": 3,
"minItems": 1,
"description": "Lead ratings to include (hot, warm, cold)."
},
"created_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created after this date-time."
},
"min_bedrooms": {
"type": "integer",
"maximum": 7,
"minimum": 1,
"description": "Minimum bedrooms they need."
},
"updated_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated after this date-time (use it to sync changes)."
},
"buying_position": {
"type": "array",
"items": {
"enum": [
"FTB",
"INV",
"BTLI",
"NPTS",
"NOM",
"OTM",
"SSTC",
"UO",
"PTS",
"DEV",
"BUY"
],
"type": "string"
},
"maxItems": 11,
"minItems": 1,
"description": "Buying positions: FTB first-time buyer, INV investor, BTLI buy to let investor, NPTS no property to sell, NOM selling (valuation stage), OTM selling (on the market), SSTC selling (sold STC), UO selling (under offer), PTS property to sell, DEV developer, BUY buying agent."
},
"follow_ups_due_to": {
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
"description": "Only applicants with a follow-up due before this date."
},
"financial_position": {
"type": "array",
"items": {
"enum": [
"NIP",
"SOAQ",
"SAMA",
"AIP",
"NFCB",
"CBFS",
"PMTG"
],
"type": "string"
},
"maxItems": 7,
"minItems": 1,
"description": "Financial positions: NIP nothing in place, SOAQ seeking own advice or quotes, SAMA seeing the agent's mortgage advisor, AIP agreement in principle in place, NFCB cash buyer (needs no finance), CBFS cash buyer with proceeds from a sale, PMTG porting mortgage."
},
"follow_ups_due_from": {
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
"description": "Only applicants with a follow-up due after this date."
}
}
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"include": {
"type": "array",
"items": {
"enum": [
"property",
"owner",
"owner.people",
"valuation",
"fees"
],
"type": "string"
},
"maxItems": 5,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: property, owner, owner.people, valuation, fees."
},
"trashed": {
"enum": [
"with",
"only"
],
"type": "string",
"description": "with = include deleted records, only = only deleted ones (default: not deleted)."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"created_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created before this date-time."
},
"updated_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated before this date-time."
},
"created_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created after this date-time."
},
"updated_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated after this date-time (use it to sync changes)."
}
}
}| string |
| Only records created after this date-time. |
| updated_from | string | Only records updated after this date-time (use it to sync changes). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"branch": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Only offers of this branch (branch UUID, see street_list_branches)."
},
"status": {
"type": "array",
"items": {
"enum": [
"pending",
"put_to_vendor",
"accepted",
"rejected",
"withdrawn"
],
"type": "string"
},
"maxItems": 5,
"minItems": 1,
"description": "Offer statuses to include."
},
"include": {
"type": "array",
"items": {
"enum": [
"property",
"salesListing",
"applicant",
"applicant.people",
"branch",
"notes"
],
"type": "string"
},
"maxItems": 6,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: property, salesListing, applicant, applicant.people, branch, notes."
},
"trashed": {
"enum": [
"with",
"only"
],
"type": "string",
"description": "with = include deleted records, only = only deleted ones (default: not deleted)."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"created_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created before this date-time."
},
"updated_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated before this date-time."
},
"created_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created after this date-time."
},
"updated_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated after this date-time (use it to sync changes)."
}
}
}| updated_to | string | Only records updated before this date-time. |
| created_from | string | Only records created after this date-time. |
| updated_from | string | Only records updated after this date-time (use it to sync changes). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"branch": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Only tasks of this branch (branch UUID, see street_list_branches)."
},
"include": {
"type": "array",
"items": {
"enum": [
"branch",
"negotiator",
"property",
"lettingsApplicant",
"salesApplicant",
"sale",
"valuation",
"viewing"
],
"type": "string"
},
"maxItems": 8,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: branch, negotiator, property, lettingsApplicant, salesApplicant, sale, valuation, viewing."
},
"subject": {
"type": "array",
"items": {
"enum": [
"property",
"lettingsApplicant",
"salesApplicant",
"sale",
"valuation",
"viewing"
],
"type": "string"
},
"maxItems": 6,
"minItems": 1,
"description": "Only records that relate to these kinds of record (property, lettingsApplicant, salesApplicant, sale, valuation, viewing)."
},
"trashed": {
"enum": [
"with",
"only"
],
"type": "string",
"description": "with = include deleted records, only = only deleted ones (default: not deleted)."
},
"property": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Only tasks of this property (UUID)."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"created_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created before this date-time."
},
"updated_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated before this date-time."
},
"created_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created after this date-time."
},
"updated_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated after this date-time (use it to sync changes)."
}
}
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"include": {
"type": "array",
"items": {
"enum": [
"property",
"property.owner",
"property.branch",
"owner",
"owner.people",
"tenants",
"notes",
"inspections",
"lettingsApplication",
"guarantors"
],
"type": "string"
},
"maxItems": 10,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: property, property.owner, property.branch, owner, owner.people, tenants, notes, inspections, lettingsApplication, guarantors."
},
"trashed": {
"enum": [
"with",
"only"
],
"type": "string",
"description": "with = include deleted records, only = only deleted ones (default: not deleted)."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"created_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created before this date-time."
},
"updated_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated before this date-time."
},
"created_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created after this date-time."
},
"updated_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated after this date-time (use it to sync changes)."
}
}
}| Only records updated after this date-time (use it to sync changes). |
| email_address | string | Only records with this email address. |
| person_status | string | current or previous. |
| telephone_number | string | Telephone number in full international format, e.g. +441614960137. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"address": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Fuzzy match on the full address text."
},
"include": {
"type": "array",
"items": {
"enum": [
"tenancies",
"tenancies.property",
"tenancies.property.branch",
"notes"
],
"type": "string"
},
"maxItems": 4,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: tenancies, tenancies.property, tenancies.property.branch, notes."
},
"trashed": {
"enum": [
"with",
"only"
],
"type": "string",
"description": "with = include deleted records, only = only deleted ones (default: not deleted)."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"created_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created before this date-time."
},
"updated_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated before this date-time."
},
"created_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created after this date-time."
},
"updated_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated after this date-time (use it to sync changes)."
},
"email_address": {
"type": "string",
"maxLength": 254,
"minLength": 3,
"description": "Only records with this email address."
},
"person_status": {
"enum": [
"current",
"previous"
],
"type": "string",
"description": "current or previous."
},
"telephone_number": {
"type": "string",
"pattern": "^\\+\\d{6,15}$",
"description": "Telephone number in full international format, e.g. +441614960137."
}
}
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"include": {
"type": "array",
"items": {
"enum": [
"branch"
],
"type": "string"
},
"maxItems": 1,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: branch."
},
"trashed": {
"enum": [
"with",
"only"
],
"type": "string",
"description": "with = include deleted records, only = only deleted ones (default: not deleted)."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"created_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created before this date-time."
},
"updated_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated before this date-time."
},
"created_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created after this date-time."
},
"updated_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated after this date-time (use it to sync changes)."
}
}
}| page_size | integer | Results per page, 1-100 (default 25). |
| created_to | string | Only records created before this date-time. |
| updated_to | string | Only records updated before this date-time. |
| booked_from | string | Only those booked after this date-time. |
| created_from | string | Only records created after this date-time. |
| updated_from | string | Only records updated after this date-time (use it to sync changes). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"type": {
"enum": [
"sales",
"lettings"
],
"type": "string",
"description": "sales or lettings."
},
"branch": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Only valuations of this branch (branch UUID, see street_list_branches)."
},
"status": {
"type": "array",
"items": {
"enum": [
"booked",
"completed",
"awaiting_response",
"instructed",
"lost",
"not_attended",
"cancelled"
],
"type": "string"
},
"maxItems": 7,
"minItems": 1,
"description": "Valuation statuses to include."
},
"include": {
"type": "array",
"items": {
"enum": [
"property",
"branch",
"notes",
"followUp",
"owner",
"owner.people",
"valuer",
"salesReport",
"lettingsReport",
"salesInstruction",
"lettingsInstruction",
"lostValuationDetail"
],
"type": "string"
},
"maxItems": 12,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: property, branch, notes, followUp, owner, owner.people, valuer, salesReport, lettingsReport, salesInstruction, lettingsInstruction, lostValuationDetail."
},
"trashed": {
"enum": [
"with",
"only"
],
"type": "string",
"description": "with = include deleted records, only = only deleted ones (default: not deleted)."
},
"booked_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only those booked before this date-time."
},
"cancelled": {
"enum": [
"with",
"only"
],
"type": "string",
"description": "with = include cancelled ones, only = only cancelled ones (default: not cancelled)."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"created_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created before this date-time."
},
"updated_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated before this date-time."
},
"booked_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only those booked after this date-time."
},
"created_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created after this date-time."
},
"updated_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated after this date-time (use it to sync changes)."
}
}
}| Only records updated after this date-time (use it to sync changes). |
| email_address | string | Only records with this email address. |
| person_status | string | current or previous. |
| property_status | array | Only vendors whose property has one of these statuses. |
| telephone_number | string | Telephone number in full international format, e.g. +441614960137. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"address": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Fuzzy match on the full address text."
},
"include": {
"type": "array",
"items": {
"enum": [
"properties",
"properties.branch",
"valuations",
"notes",
"negotiator"
],
"type": "string"
},
"maxItems": 5,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: properties, properties.branch, valuations, notes, negotiator."
},
"trashed": {
"enum": [
"with",
"only"
],
"type": "string",
"description": "with = include deleted records, only = only deleted ones (default: not deleted)."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"created_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created before this date-time."
},
"updated_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated before this date-time."
},
"created_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created after this date-time."
},
"updated_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated after this date-time (use it to sync changes)."
},
"email_address": {
"type": "string",
"maxLength": 254,
"minLength": 3,
"description": "Only records with this email address."
},
"person_status": {
"enum": [
"current",
"previous"
],
"type": "string",
"description": "current or previous."
},
"property_status": {
"type": "array",
"items": {
"enum": [
"not_on_the_market",
"valuation_lost",
"valuation_booked",
"valuation_pending",
"valuation_cancelled",
"valuation_completed",
"instructed",
"for_sale",
"under_offer",
"sold_stc",
"exchanged",
"for_sale_and_to_let",
"withdrawn_sales",
"withdrawn_sales_and_lettings",
"completed"
],
"type": "string"
},
"maxItems": 15,
"minItems": 1,
"description": "Only vendors whose property has one of these statuses."
},
"telephone_number": {
"type": "string",
"pattern": "^\\+\\d{6,15}$",
"description": "Telephone number in full international format, e.g. +441614960137."
}
}
}| integer |
| Results per page, 1-100 (default 25). |
| created_to | string | Only records created before this date-time. |
| updated_to | string | Only records updated before this date-time. |
| booked_from | string | Only those booked after this date-time. |
| created_from | string | Only records created after this date-time. |
| updated_from | string | Only records updated after this date-time (use it to sync changes). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"type": {
"enum": [
"sales",
"lettings"
],
"type": "string",
"description": "sales or lettings."
},
"branch": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Only viewings of this branch (branch UUID, see street_list_branches)."
},
"status": {
"type": "array",
"items": {
"enum": [
"unconfirmed",
"rejected",
"confirmed",
"cancelled",
"completed",
"missed"
],
"type": "string"
},
"maxItems": 6,
"minItems": 1,
"description": "Viewing statuses to include."
},
"include": {
"type": "array",
"items": {
"enum": [
"property",
"applicant",
"branch",
"notes",
"owner",
"owner.people",
"viewer",
"viewingFeedback"
],
"type": "string"
},
"maxItems": 8,
"minItems": 1,
"description": "Related records to embed in \"included\". Allowed: property, applicant, branch, notes, owner, owner.people, viewer, viewingFeedback."
},
"trashed": {
"enum": [
"with",
"only"
],
"type": "string",
"description": "with = include deleted records, only = only deleted ones (default: not deleted)."
},
"booked_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only those booked before this date-time."
},
"cancelled": {
"enum": [
"with",
"only"
],
"type": "string",
"description": "with = include cancelled ones, only = only cancelled ones (default: not cancelled)."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"created_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created before this date-time."
},
"updated_to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated before this date-time."
},
"booked_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only those booked after this date-time."
},
"created_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records created after this date-time."
},
"updated_from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Only records updated after this date-time (use it to sync changes)."
}
}
}| boolean |
| Whether the person agreed to marketing. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"person_id"
],
"properties": {
"title": {
"anyOf": [
{
"type": "string",
"maxLength": 30
},
{
"type": "null"
}
],
"description": "Title such as Mr, Mrs, Dr; null clears it."
},
"last_name": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "New last name."
},
"person_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Person UUID (street_list_people)."
},
"first_name": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "New first name."
},
"contact_post": {
"type": "boolean",
"description": "Contact preference: post."
},
"contact_text": {
"type": "boolean",
"description": "Contact preference: text message."
},
"contact_email": {
"type": "boolean",
"description": "Contact preference: email."
},
"contact_phone": {
"type": "boolean",
"description": "Contact preference: phone."
},
"marketing_consent": {
"type": "boolean",
"description": "Whether the person agreed to marketing."
}
}
}