Get a List of Users

Endpoint essentials
API key accessapi/v1/users/search or Master API key
OAuth scopesusers_list
Credit usage0 credits
Learn more about API pricing and credits.

Users are the people who use your Apollo workspace.

Use the Get a List of Users endpoint to retrieve the IDs for all of the users in your Apollo account.

These IDs can be used for several other endpoints, including the Create a Deal, Create an Account, and Create a Task endpoints.

Query Params
int32

The page number of the Apollo data that you want to retrieve.

Use this parameter in combination with the per_page parameter to make search results for navigable and improve the performance of the endpoint.

Example: 4

int32

The number of search results that should be returned for each page. Limiting the number of results per page improves the endpoint's performance.

Use the page parameter to search the different pages of data.

Example: 10

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain