v1
latestOpenAPI 3.1.02026-07-247601.0 MBGet a List of Users
This endpoint doesn't consume Apollo credits. Learn more about API pricing and credits.
<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
The page number of the Apollo data that you want to retrieve. <br><br>Use this parameter in combination with the per_page parameter to make search results for navigable and improve the performance of the endpoint. <br><br>Example: 4
The number of search results that should be returned for each page. Limiting the number of results per page improves the endpoint's performance. <br><br>Use the page parameter to search the different pages of data. <br><br>Example: 10
Response
200
Example response
{
"pagination": {
"page": "1",
"per_page": "3",
"total_entries": 23,
"total_pages": 8
},
"users": [
{
"id": "66c8db577ed7f201b25c0eef",
"team_id": "6095a710bd01d100a506d4ac",
"email": "anita.rao@apollomail.io",
"created_at": "2024-08-23T18:56:24.067Z",
"opt_out_html_template": "No longer interested in these messages? <%Unsubscribe%>",
"referral_code": "nzu90RCUSGkFzsavf4Efh3",
"current_email_verified": true,
"record_calls": true,
"permission_set_id": "6170904d46a82c00c227b744",
"zp_contact_id": "66ca3f1309358c0001ea7e4d",
"data_request_emails": true,
"daily_task_email": true,
"free_data_credits_email": true,
"dismiss_new_team_suggestion": true,
"territory_is_active": true,
"show_deals_detail_page_updates_modal": true,
"assistant_setting": {
"_id": "66c8db587ed7f201b25c0ef0",
"deal_size_metric": "amount",
"latest_funding_days": 90,
"max_num_active_accounts": 100,
"max_people_in_sequence_per_account": 5,
"num_inactive_days_to_re_engage": 180,
"persona_ids": [
"65d829661453d30300a0c9e3"
],
"should_show_persona_banner": true,
"team_id": "6095a710bd01d100a506d4ac",
"territory_locations": [
"United States"
],
"territory_person_locations": [
"United States"
],
"user_id": "66c8db577ed7f201b25c0eef",
"id": "66c8db587ed7f201b25c0ef0",
"key": "66c8db587ed7f201b25c0ef0"
},
"fields_fully_loaded": true,
"enable_open_tracking": true,
"linked_bot_conference_account": true,
"linked_bot_conference_account_platforms": [
"google_meet"
],
"has_conference_account": true,
"chrome_extension_enabled_features": [
"apollo_everywhere"
],
"chrome_extension_exclude_from_websites": [
"facebook.com"
],
"chrome_extension_everywhere_icon_horizontal_position": "right",
"chrome_extension_everywhere_icon_vertical_position_in_vh": 10,
"default_chrome_extension_log_email_send_to_salesforce": true,
"default_chrome_extension_log_email_send_to_hubspot": true,
"chrome_extension_auto_match_salesforce_opportunity": true,
"chrome_extension_gmail_enable_email_tools": true,
"chrome_extension_gmail_enable_crm_sidebar": true,
"show_chrome_extension_buying_intent_promo": true
}
]
}