---
title: "Get Current User Profile"
method: GET
path: "/users/api_profile"
---

# Get Current User Profile

`GET /users/api_profile`

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 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.

## Query parameters

- `include_credit_usage` boolean

## Response `200`

200

- object
  - `id` string
  - `team_id` string
  - `first_name` string
  - `last_name` string
  - `title` string
  - `email` string
  - `num_credits_remaining` integer — Remaining lead credits for the user. Only present when `include_credit_usage=true`.
  - `effective_num_lead_credits` integer — Effective lead credit allowance for the user. Only present when `include_credit_usage=true`.
  - `num_lead_credits_used` integer — Lead credits used by the user. Only present when `include_credit_usage=true`.
  - `effective_num_direct_dial_credits` integer — Effective direct dial credit allowance for the user. Only present when `include_credit_usage=true`.
  - `num_direct_dial_credits_used` integer — Direct dial credits used by the user. Only present when `include_credit_usage=true`.
  - `effective_num_export_credits` integer — Effective export credit allowance for the user. Only present when `include_credit_usage=true`.
  - `num_export_credits_used` integer — Export credits used by the user. Only present when `include_credit_usage=true`.
  - `effective_num_ai_credits` integer — Effective AI credit allowance for the user. Only present when `include_credit_usage=true`.
  - `num_ai_credits_used` integer — AI credits used by the user. Only present when `include_credit_usage=true`.
  - `effective_num_power_up_credits` integer — Effective power-up credit allowance for the team. Only present when `include_credit_usage=true`.
  - `num_power_up_credits_used` integer — Power-up credits used (user this cycle on unified credits, otherwise team total). Only present when `include_credit_usage=true`.
  - `total_unified_credits_used` integer — 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.

## Other responses

- `401` — 401

---

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