HTTP Request

POST/contacts/api/v1/offers/search/

Example Response

{
"id": 0,
"tags": [],
"site": 0,
"lead": 0,
"contact": 0,
"communication": 0,
"viewing": 0,
"offer": 0,
"user": 0,
"agent": 0,
"meta": {},
"created": "2026-09-08T14:40:53.584Z",
"modified": "2026-09-08T14:40:53.584Z",
"source_ref": "string",
"rental_application": 0,
"archive": 0
}

NameDescription

id

integer

ID

tags

nullable

array of strings

Choices: [ 1,2,3...2147483648 ]

site

integer

Site

lead

required

integer

Lead

contact

integer

Contact

communication

integer

Communication

viewing

integer

Viewing

offer

integer

Offer

user

integer

User

agent

integer

Agent

meta

string

Meta

created

string

Created

modified

string

Modified

source_ref

nullable

string<= 100 characters

Source ref - A unique reference to use for linking records back to *your* system. NB: This must be unique across the entire Prop Data system, so it's best to use a consistent prefix unique to your integration to avoid conflicts with other api consumers.

rental_application

nullable

integer

Rental application

archive

nullable

integer

Archive

Responses

201