> ## Documentation Index > Fetch the complete documentation index at: https://api.housera.ro/llms.txt > Use this file to discover all available pages before exploring further. # Client requests > The messages, call requests and viewing requests the account sees in its portal inbox, with the clients' contact details, oldest first, with cursor pagination. Requires the `leads:read` permission. You can filter by listing (`listing` or `external_ref`), by date (`since`) and with the portal's filters: the stage (`status`), the channel (`source`), the colleague who holds the request (`agent`), the office (`office`) and the search (`q`). ## OpenAPI ````yaml en/openapi.json GET /leads openapi: 3.1.2 info: title: Housera API version: 1.0.0 description: >- Publish and manage real estate listings on Housera from your CRM or your own application, under the same rules as the form on the Housera portal. servers: - url: https://staging.housera.ro/api/v1 description: 'Sandbox (staging): test data, same rules as production.' - url: https://housera.ro/api/v1 description: 'Production: the real listings on housera.ro.' security: - bearer: [] tags: - name: Your listings - name: Photos - name: Events - name: Vocabulary - name: Connect with Housera - name: Client requests - name: The company and its team - name: Marketing mandates - name: Viewings - name: Projects - name: Partnerships - name: API key - name: Statistics paths: /leads: get: tags: - Client requests summary: Client requests description: >- The messages, call requests and viewing requests the account sees in its portal inbox, with the clients' contact details, oldest first, with cursor pagination. Requires the `leads:read` permission. You can filter by listing (`listing` or `external_ref`), by date (`since`) and with the portal's filters: the stage (`status`), the channel (`source`), the colleague who holds the request (`agent`), the office (`office`) and the search (`q`). operationId: v1.leads.index parameters: - name: listing in: query schema: type: - string - 'null' maxLength: 20 description: The listing's public code (8 characters). - name: external_ref in: query schema: type: - string - 'null' maxLength: 100 description: >- 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`. - name: since in: query schema: type: - string - 'null' format: date-time description: >- Only requests received or changed after this moment (ISO 8601, with a time zone). Use it for incremental sync. - name: inbox in: query schema: type: - string - 'null' enum: - 'true' - 'false' - '1' - '0' - null description: >- `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. - name: status in: query schema: anyOf: - $ref: '#/components/schemas/LeadStatus' - type: 'null' description: >- Only requests at this stage: `new`, `contacted`, `viewing`, `offer` or `closed`. - name: source in: query schema: anyOf: - $ref: '#/components/schemas/LeadSource' - type: 'null' description: >- Only requests that came in on this channel: `message`, `phone`, `viewing_request`, `referral` or `other`. - name: agent in: query schema: type: - string - 'null' format: email maxLength: 254 description: >- Only the requests held by the colleague with this email. An email that belongs to nobody gets you an empty list. - name: office in: query schema: type: - integer - 'null' minimum: 1 description: >- Only the requests of the office with this id, the one in the request's `office.id`. - name: q in: query schema: type: - string - 'null' maxLength: 100 description: >- 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. - name: complex in: query schema: type: - string - 'null' maxLength: 20 description: >- 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. - name: per_page in: query schema: type: - integer - 'null' minimum: 1 maximum: 100 description: Results per page (default 50, maximum 100). - name: cursor in: query schema: type: - string - 'null' description: >- The next page's cursor, from `meta.next_cursor`, sent exactly as you received it. Any other value gets 422 (`pagination_cursor`). - name: locale in: query required: false schema: type: string enum: - ro - en default: en example: en description: >- 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. responses: '200': content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/LeadApiResource' description: The result of the request. links: type: object properties: first: type: - string - 'null' description: The first page's URL. last: type: - string - 'null' description: The last page's URL (null with cursor pagination). prev: type: - string - 'null' description: The previous page's URL, or null. next: type: - string - 'null' description: >- The next page: its URL, or the cursor to pass on. Null when there is nothing left. required: - first - last - prev - next description: Pagination links. meta: type: object properties: path: type: - string - 'null' description: The list's base URL. per_page: type: integer minimum: 0 description: Results per page. next_cursor: type: - string - 'null' description: The next page's cursor; null when the list has ended. prev_cursor: type: - string - 'null' description: The previous page's cursor; null on the first page. required: - path - per_page - next_cursor - prev_cursor description: >- Data about the response, outside the result, for example a list's pagination. required: - data - links - meta description: The request succeeded. '401': content: application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The key is missing, revoked or expired (`unauthenticated`). '403': content: application/problem+json: schema: $ref: '#/components/schemas/Problem' description: >- The key lacks the required permission (`missing_ability`) or access is denied (`forbidden`). '422': content: application/problem+json: schema: $ref: '#/components/schemas/ValidationProblem' description: >- The data fails the rules: one entry per field in `errors[]`, each with a stable `code`. '429': content: application/problem+json: schema: $ref: '#/components/schemas/Problem' description: >- Too many requests. Try again after the number of seconds in `Retry-After`. components: schemas: LeadStatus: type: string enum: - new - contacted - viewing - offer - closed title: LeadStatus LeadSource: type: string enum: - phone - message - viewing_request - referral - other title: LeadSource LeadApiResource: type: object properties: id: type: integer description: >- The request ID. The `lead.created` and `lead.updated` events carry the same one. source: type: - string - 'null' enum: - phone - message - viewing_request - referral - other - null description: >- How the first request came in: `message`, `phone` (call request), `viewing_request`, `referral` or `other` (added by hand in the portal). When the same client sends another request on the same listing, you get a `lead.updated` event with that request's channel in its `source`. status: type: string enum: - new - contacted - viewing - offer - closed description: >- The request's stage in the portal: `new`, `contacted`, `viewing`, `offer` or `closed`. listing: type: - object - 'null' properties: code: type: string description: The listing's public code. external_ref: type: - string - 'null' description: >- 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`. required: - code - external_ref description: >- The listing the request came through; `null` for a request sent from the agency's page or added by hand. complex: type: - object - 'null' properties: code: type: string description: The development's public code. title: type: - string - 'null' description: The development's title. url: type: string description: The development's address on Housera. required: - code - title - url description: >- At a developer, the request's project: the development it came on, or the one the unit is part of, with `code`, `title` and `url`. `null` outside a project. contact: type: object properties: name: type: string description: The client's name. phone: type: - string - 'null' description: The client's phone number (E.164), if there is one. email: type: - string - 'null' description: The client's email, if there is one. required: - name - phone - email description: The client's contact details. message: type: - string - 'null' description: >- What the client wrote: their first message on the listing, or the text sent from the agency's page. `null` if they wrote nothing, for example on a call request. erased: type: boolean description: >- `true` when the client deleted their account: the name is anonymized, and the phone, email, message and note are `null`. Delete the client's data from your copy too. note: type: - string - 'null' description: >- The account's note on the request, as in the portal. For a request sent from the agency's page, the note starts with the client's text. price: type: - integer - 'null' description: >- The amount the client offered, in whole euros, as in the portal; `null` when none is set. agent: type: - object - 'null' properties: name: type: string description: >- The name of the agent's account. The portal shows the name in `display_name`. email: type: - string - 'null' description: >- The agent's email; `null` when we have no real address for them, for example a colleague who came from a CRM with no email on their team record. display_name: type: string description: >- The agent's approved public name, the one the portal shows next to the request. It differs from `name` when the agent has a different public name approved. required: - name - email - display_name description: >- The agent who holds the request in the portal; `null` while it waits in the company's inbox for someone to take it. requests: type: object properties: callback_at: type: - string - 'null' description: >- The client's latest call request (ISO 8601); `null` if they never asked to be called. viewing_at: type: - string - 'null' description: >- The client's latest viewing request (ISO 8601); `null` if they never asked for a viewing. required: - callback_at - viewing_at description: >- When the client last asked to be called and to come to a viewing, as in the portal. `source` only gives the channel of the first request. office: type: - object - 'null' properties: id: type: integer description: The office's id. Send it as `office` in `GET /leads`. name: type: string description: >- The office's name. The head office is named in the language of the response: “Head office” in English, “Sediu” in Romanian. required: - id - name description: The request's office; `null` for a request outside a company. inbox: type: - object - 'null' properties: reason: type: string enum: - no_listing - left - no_agent description: >- Why it waits: `no_listing` (the client wrote from the company's page), `left` (the agent who held the request or the listing left the company or was deactivated) or `no_agent` (the listing has no active agent). since: type: - string - 'null' description: When the request came in (ISO 8601), as in the portal. required: - reason - since description: >- Why the request waits in “To take”, and when it came in; `null` while someone holds it. created_at: type: - string - 'null' description: When the request came in (ISO 8601). updated_at: type: - string - 'null' description: The request's last change in the portal (ISO 8601). required: - id - source - status - listing - complex - contact - message - erased - note - price - agent - requests - office - inbox - created_at - updated_at title: LeadApiResource Problem: type: object title: Problem properties: type: type: string format: uri description: The URL of the problem type (RFC 9457). title: type: string description: A short summary of the problem, in the request's language. status: type: integer description: The HTTP status code. code: type: string description: >- The stable code of the refusal, the one to handle the error by (the list is on the Errors page). detail: type: string description: The explanation, in the request's language. existing: type: object properties: code: type: string description: The existing listing's public code. external_ref: type: - string - 'null' description: >- Your ID for the existing listing, if you set it with `PUT /listings/ref/{ref}`. Otherwise `null`. required: - code - external_ref description: >- Only on `409 duplicate_listing`: the listing you already have for the same property. required: - type - title - status - code - detail ValidationProblem: type: object title: ValidationProblem properties: type: type: string format: uri description: The URL of the problem type (RFC 9457). title: type: string description: A short summary of the problem, in the request's language. status: type: integer description: 'The HTTP status code: `422`.' errors: type: array items: type: object properties: pointer: type: string description: The field it refers to, as a JSON Pointer (`/features/2`). code: type: string description: >- The rule that failed, as a stable code (the list is on the Errors page). detail: type: string description: >- The explanation, in the request's language. The wording can change, so handle the error by `code`. required: - pointer - code - detail description: One entry for each field that fails the rules. required: - type - title - status - errors securitySchemes: bearer: type: http scheme: bearer description: 'Authorization: Bearer ' ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.