Sign in

v1

latestOpenAPI 3.1.02026-07-247601.0 MB

Get Current User Profile

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 Current User Profile endpoint to retrieve the authenticated profile of the person who owns the API key being used.<br><br>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.<br><br>If you call this endpoint without valid access credentials, you receive a 401 response.

get/users/api_profile

Query parameters

include_credit_usageboolean

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. <br><br>Example: true

Response

200

idstring
team_idstring
first_namestring
last_namestring
titlestring
emailstring
num_credits_remaininginteger

Remaining lead credits for the user. Only present when include_credit_usage=true.

effective_num_lead_creditsinteger

Effective lead credit allowance for the user. Only present when include_credit_usage=true.

num_lead_credits_usedinteger

Lead credits used by the user. Only present when include_credit_usage=true.

effective_num_direct_dial_creditsinteger

Effective direct dial credit allowance for the user. Only present when include_credit_usage=true.

num_direct_dial_credits_usedinteger

Direct dial credits used by the user. Only present when include_credit_usage=true.

effective_num_export_creditsinteger

Effective export credit allowance for the user. Only present when include_credit_usage=true.

num_export_credits_usedinteger

Export credits used by the user. Only present when include_credit_usage=true.

effective_num_ai_creditsinteger

Effective AI credit allowance for the user. Only present when include_credit_usage=true.

num_ai_credits_usedinteger

AI credits used by the user. Only present when include_credit_usage=true.

effective_num_power_up_creditsinteger

Effective power-up credit allowance for the team. Only present when include_credit_usage=true.

num_power_up_credits_usedinteger

Power-up credits used (user this cycle on unified credits, otherwise team total). Only present when include_credit_usage=true.

total_unified_credits_usedinteger

Sum of lead, direct dial, export, and power-up credits used. Only present when include_credit_usage=true and the team is on unified credits.

Example response

{
  "id": "66c8db577ed7f201b25c0eef",
  "team_id": "6095a710bd01d100a506d4ac",
  "first_name": "John",
  "last_name": "Doe",
  "title": "Developer",
  "email": "john.doe@example.com",
  "num_credits_remaining": 9500,
  "effective_num_lead_credits": 10000,
  "num_lead_credits_used": 500,
  "effective_num_direct_dial_credits": 1000,
  "num_direct_dial_credits_used": 120,
  "effective_num_export_credits": 5000,
  "num_export_credits_used": 250,
  "effective_num_ai_credits": 2000,
  "num_ai_credits_used": 75,
  "effective_num_power_up_credits": 1000,
  "num_power_up_credits_used": 40,
  "total_unified_credits_used": 910
}