Get Current User Profile

Endpoint essentials
API key accessapi/v1/users/api_profile or Master API key
OAuth scopesread_user_profile
Credit usage0 credits
Learn more about API pricing and credits.
Authentication note: Default scope — granted automatically on every OAuth token.

Users are the people who use your Apollo workspace.

Use the Get Current User Profile endpoint to retrieve the authenticated profile of the person who owns the API key being used.

By default, the endpoint returns the user's identity fields. Set the include_credit_usage query parameter to true to also return the user's and team's credit usage and remaining credit balances.

If you call this endpoint without valid access credentials, you receive a 401 response.

Query Params
boolean
Defaults to false

Set to true to include credit usage and remaining credit details (lead, direct dial, export, AI, and power-up credits) in the response. Accepts boolean (true/false) or string ("true"/"false") values. Defaults to false.

Example: true

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