---
title: "Get a List of Users"
method: GET
path: "/users/search"
tags: ["Miscellaneous"]
---

# Get a List of Users

`GET /users/search`

This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).

<a href="https://knowledge.apollo.io/hc/en-us/articles/4409130537101-Add-Manage-and-Deactivate-Users" target="_blank">Users</a> are the people who use your Apollo workspace.<br><br>Use the Get a List of Users endpoint to retrieve the IDs for all of the users in your Apollo account.<br><br>These IDs can be used for several other endpoints, including the <a href="https://docs.apollo.io/reference/create-deal">Create a Deal</a>, <a href="https://docs.apollo.io/reference/create-an-account">Create an Account</a>, and <a href="https://docs.apollo.io/reference/create-a-task">Create a Task</a> endpoints.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master API key.

## Query parameters

- `page` integer
- `per_page` integer

## Response `200`

200

- object
  - `pagination` object
    - `page` string
    - `per_page` string
    - `total_entries` integer
    - `total_pages` integer
  - `users` object[]
    - `id` string
    - `team_id` string
    - `first_name` unknown
    - `last_name` unknown
    - `title` unknown
    - `email` string
    - `created_at` string
    - `credit_limit` unknown
    - `direct_dial_credit_limit` unknown
    - `export_credit_limit` unknown
    - `ai_credit_limit` unknown
    - `salesforce_account` unknown
    - `deleted` boolean
    - `opt_out_html_template` string
    - `name` string
    - `referral_code` string
    - `password_needs_reset` boolean
    - `salesforce_id` unknown
    - `default_cockpit_layout` unknown
    - `default_account_overview_layout_id` unknown
    - `default_contact_overview_layout_id` unknown
    - `default_person_overview_layout_id` unknown
    - `default_organization_overview_layout_id` unknown
    - `default_opportunity_overview_layout_id` unknown
    - `default_home_overview_layout_id` unknown
    - `bridge_calls` boolean
    - `bridge_phone_number` unknown
    - `bridge_incoming_calls` boolean
    - `bridge_incoming_phone_number` unknown
    - `current_email_verified` boolean
    - `record_calls` boolean
    - `salesforce_instance_url` unknown
    - `permission_set_id` string
    - `default_use_local_numbers` boolean
    - `disable_email_linking` unknown
    - `sync_salesforce_id` unknown
    - `sync_crm_id` unknown
    - `zp_contact_id` string
    - `chrome_extension_downloaded` boolean
    - `zp_is_super_analytics_user` unknown
    - `email_oauth_signin_only` boolean
    - `notification_last_created_at` unknown
    - `crm_requested_to_integrate` unknown
    - `has_invited_user` boolean
    - `has_used_enrichment` boolean
    - `has_uploaded_csv` boolean
    - `has_hidden_onboarding` boolean
    - `notification_last_read_at` unknown
    - `daily_data_request_email` boolean
    - `data_request_emails` boolean
    - `daily_task_email` boolean
    - `free_data_credits_email` boolean
    - `dismiss_new_team_suggestion` boolean
    - `request_email_change_to` unknown
    - `self_identified_persona` unknown
    - `territory_is_active` boolean
    - `conversation_is_private` unknown
    - `show_deals_detail_page_updates_modal` boolean
    - `assistant_setting` object
      - `_id` string
      - `deal_size_metric` string
      - `inactive_account_stage_ids` unknown[]
        - unknown
      - `inactive_contact_stage_ids` unknown[]
        - unknown
      - `insight_deal_size_signals` object
      - `insight_sale_cycle_signals` object
      - `insight_win_rate_signals` object
      - `is_persona_recommendation_requested` boolean
      - `job_posting_locations` unknown[]
        - unknown
      - `job_posting_titles` unknown[]
        - unknown
      - `latest_funding_days` integer
      - `max_num_active_accounts` integer
      - `max_people_in_sequence_per_account` integer
      - `num_inactive_days_to_re_engage` integer
      - `persona_ids` string[]
      - `should_show_persona_banner` boolean
      - `success_case_account_stage_ids` unknown[]
        - unknown
      - `team_id` string
      - `technology_uids` unknown[]
        - unknown
      - `territory_company_size_ranges` unknown[]
        - unknown
      - `territory_location_override` boolean
      - `territory_locations` string[]
      - `territory_person_locations` string[]
      - `user_id` string
      - `id` string
      - `key` string
    - `fields_fully_loaded` boolean
    - `typed_custom_fields` unknown
    - `connected_to_slack` boolean
    - `crm_email` unknown
    - `triggered_referral_campaigns` unknown[]
      - unknown
    - `enable_click_tracking` boolean
    - `enable_open_tracking` boolean
    - `should_include_unsubscribe_link` boolean
    - `enable_one_click_unsubscribe` unknown
    - `subteam_ids` unknown[]
      - unknown
    - `prospect_territory_ids` unknown[]
      - unknown
    - `toggled_on_territory_ids` unknown[]
      - unknown
    - `linked_salesforce` unknown
    - `linked_zoom_conference_account` boolean
    - `linked_bot_conference_account` boolean
    - `linked_bot_conference_account_platforms` string[]
    - `has_conference_account` boolean
    - `linked_hubspot` boolean
    - `linked_salesloft` boolean
    - `linked_crm_name` unknown
    - `chrome_extension_enabled_features` string[]
    - `chrome_extension_exclude_from_websites` string[]
    - `chrome_extension_everywhere_icon_horizontal_position` string
    - `chrome_extension_everywhere_icon_vertical_position_in_vh` integer
    - `default_chrome_extension_log_email_send_to_salesforce` boolean
    - `default_chrome_extension_log_email_send_to_hubspot` boolean
    - `chrome_extension_auto_match_salesforce_opportunity` boolean
    - `chrome_extension_gmail_enable_email_tools` boolean
    - `enable_desktop_notifications` boolean
    - `enable_gmail_desktop_notifications` unknown
    - `default_chrome_extension_enable_reminders` boolean
    - `chrome_extension_gmail_enable_crm_sidebar` boolean
    - `show_chrome_extension_buying_intent_promo` boolean
    - `apollo_everywhere_search_count` integer
  - `num_fetch_result` unknown

## Other responses

- `401` — 401
- `403` — 403
- `429` — 429

---

[API](https://skmtc.dev/apollo/apis/apollo-rest-api.md) · [All operations](https://skmtc.dev/apollo/apis/apollo-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/apollo/apollo-rest-api/revisions/c715a05fa6e2/schema)