---
title: "Scroll endpoint for clients"
method: GET
path: "/clients/scroll"
tags: ["clients"]
---

# Scroll endpoint for clients

`GET /clients/scroll`

Search endpoint has a limitation of 50_000 items that can be fetched. When we need to scroll out of this limit, we must use this specific endpoint. Use it if you need to iterate across all of your entities. Use the param "with_total=true" only on the first call, we have an optimisation that increases response when this attribute is unused
It does not accept search parameters that are not mentioned in the documentation.

## Query parameters

- `with_total` boolean
- `updated_at_from` string, date
- `updated_at_to` string, date
- `scroll_id` string
- `per` integer
- `include_children` boolean

## Response `200`

Scroll endpoint for clients

- EndpointsClientsScroll — Endpoints_ClientsScroll model
  - `data` ClientEntity[]
    - `id` integer
    - `old_crm_id` integer
    - `broker_id` integer
    - `broker_ids` integer[]
    - `second_broker_id` integer
    - `item_id` integer
    - `salutation` string
    - `academic_title` string
    - `first_name` string
    - `last_name` string
    - `name` string
    - `home_address` string
    - `office_address` string
    - `phone` string
    - `home_phone` string
    - `home_cell` string
    - `office_phone` string
    - `office_cell` string
    - `email` string
    - `dob` string
    - `birth_name` string
    - `birth_place` string
    - `birth_country` string
    - `identity_number` string
    - `issuing_authority` string
    - `nationality` string
    - `rating` integer
    - `description` string
    - `company` string
    - `position` string
    - `full_salutation` string
    - `emails` string[]
    - `photo` ClientPhotoEntity
      - `urls` object — Photo URLs by size: original keeps the uploaded dimensions, small is 100x100, medium is 512x512, large is 1024x1024
    - `home_street` string
    - `home_house_number` string
    - `home_zip_code` string
    - `home_city` string
    - `home_country` string
    - `office_street` string
    - `office_house_number` string
    - `office_zip_code` string
    - `office_city` string
    - `office_country` string
    - `tax_identification_number` string
    - `token` string
    - `parent_id` integer
    - `client_status_id` integer
    - `client_source_id` integer
    - `folder_ids` integer[]
    - `group_ids` integer[]
    - `child_ids` integer[]
    - `mailchimp_interest_ids` string[]
    - `delete_with_activities` boolean
    - `client_addresses` ClientAddressEntity
      - `id` integer
      - `value` string
      - `label` string
    - `language` string
    - `custom_fields` object
    - `income` string
    - `handover_date` string
    - `rent_date` string
    - `mvsigned` boolean
    - `hvsigned` boolean
    - `followup_date` string
    - `newsletter` boolean
    - `newsletter_unsubscribed` boolean
    - `property_mailing_wanted` boolean
    - `accept_contact` boolean
    - `locked` boolean
    - `archived` boolean
    - `message_salutation` string
    - `warning_notice` string
    - `pass_type` string
    - `conspicuity` string
    - `legal_form` string
    - `register_number` string
    - `creator_id` integer
    - `updater_id` integer
    - `home_url` string
    - `office_url` string
    - `matrimonial_property_scheme` string
    - `bank_name` string
    - `bank_account_owner` string
    - `bank_iban` string
    - `bank_bic` string
    - `gdpr_status` integer
    - `client_reason_id` integer
    - `project_ids` integer[]
    - `commercial` boolean
    - `has_tipster` boolean
    - `cp_delete_request_date` string
    - `keep_data_till` string
    - `created_at` string
    - `updated_at` string
    - `last_contact_at` string
    - `last_interaction_at` string
    - `last_response_at` string
  - `total` integer — Show the total count of contacts
  - `scroll_id` string — Search pointer that should be sent for switching page in scroll mode

## Other responses

- `400` — validation_error
- `401` — authentication_error
- `403` — authorization_error
- `404` — not_found_error
- `422` — validation_error
- `500` — internal_server_error

---

[API](https://skmtc.net/propstack/apis/propstack-api-v2-beta.md) · [All operations](https://skmtc.net/propstack/apis/propstack-api-v2-beta/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/propstack/propstack-api-v2-beta/revisions/ae1e0fe6da1a/schema)