Skip to main content
GET
Client requests

Authorizations

Authorization
string
header
required

Authorization: Bearer

Query Parameters

listing
string | null

The listing's public code (8 characters).

Maximum string length: 20
external_ref
string | null

The listing's ID in your system, if you created it with PUT /listings/ref/{ref}. Only a key in the space where it was set can see it; for every other key it is null.

Maximum string length: 100
since
string<date-time> | null

Only requests received or changed after this moment (ISO 8601, with a time zone). Use it for incremental sync.

inbox
enum<string> | null

true for the requests in “To take”: those nobody is responsible for yet, which the account can take with POST /leads/{lead}/take. Without it you get the requests the account already sees in the portal.

Available options:
true,
false,
1,
0,
null
status
enum<string> | null

Only requests at this stage: new, contacted, viewing, offer or closed.

Available options:
new,
contacted,
viewing,
offer,
closed
source
enum<string> | null

Only requests that came in on this channel: message, phone, viewing_request, referral or other.

Available options:
phone,
message,
viewing_request,
referral,
other
agent
string<email> | null

Only the requests held by the colleague with this email. An email that belongs to nobody gets you an empty list.

Maximum string length: 254
office
integer | null

Only the requests of the office with this id, the one in the request's office.id.

Required range: x >= 1
q
string | null

Searches like the portal's search bar: the name, the note, the start of the email and the phone, written any way (0740 111 222 finds +40740111222). The owner, admins and managers also find requests by the name of the colleague who holds them.

Maximum string length: 100
complex
string | null

The development code of a developer's project: only the requests on the development and on its units. An unknown code returns an empty list.

Maximum string length: 20
per_page
integer | null

Results per page (default 50, maximum 100).

Required range: 1 <= x <= 100
cursor
string | null

The next page's cursor, from meta.next_cursor, sent exactly as you received it. Any other value gets 422 (pagination_cursor).

locale
enum<string>
default:en

The response language, ro or en. It changes error messages (title, detail), labels and, when the listing has an approved translation in that language, its title and description. Codes are the same in every language. It takes precedence over Accept-Language and over the account's language.

Available options:
ro,
en

Response

The request succeeded.

data
LeadApiResource · object[]
required

The result of the request.

Pagination links.

meta
object
required

Data about the response, outside the result, for example a list's pagination.