> ## Documentation Index
> Fetch the complete documentation index at: https://www.forager.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Forager is a REST API for B2B people, company and job post data: contact lookups (phone numbers, personal emails, work emails), person, company and job post search, and bulk data feeds.
> Server: https://api-v2.forager.ai. Send the API key in the X-API-KEY header. Most paths include {account_id}. Read FORAGER_API_KEY and FORAGER_ACCOUNT_ID from the environment; never put the key in client-side code, logs or prompts.
> To add Forager to a project, follow https://www.forager.ai/docs/guides/agent-quickstart.md. To pick an endpoint, read https://www.forager.ai/docs/guides/choose-an-endpoint.md. For end-to-end builds, see https://www.forager.ai/docs/recipes/overview.md.
> Most requests spend credits. Do not guess costs; use https://www.forager.ai/docs/api-overview/credit-pricing.md and ask the user before spending credits.
> Use only endpoints and fields defined in https://www.forager.ai/docs/openapi.yaml. Forager has no MCP server for the API yet; the /mcp endpoint on this site searches the documentation only.

# View user information

> Retrieve the details of the current authenticated Forager user.

## When to use this endpoint

You want to know which user and accounts a key belongs to, and the credit balance of each account, for example to pick the right Account ID or to show the balance in your own app.

## Example request

```bash cURL theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl "https://api-v2.forager.ai/api/users/current/" \
  -H "X-API-KEY: $FORAGER_API_KEY"
```

Set `FORAGER_API_KEY` and `FORAGER_ACCOUNT_ID` as in the [quickstart](https://www.forager.ai/docs/api-overview/send-your-first-request.md).

## Example response

```json 200 (illustrative values) theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "id": 1,
  "username": "jane.doe@example.com",
  "email": "jane.doe@example.com",
  "first_name": "Jane",
  "last_name": "Doe",
  "accounts": [
    {
      "id": 123456,
      "name": "Acme Example",
      "subscription": {
        "id": 77,
        "is_active": true,
        "credits_balance": "1250.00",
        "subscription_tier": {
          "id": 2,
          "name": "Example plan",
          "features": [],
          "stripe_subscription_prices": []
        },
        "stripe_subscription_id": null,
        "stripe_subscription_price": {
          "id": 9
        }
      }
    }
  ]
}
```

The `accounts[].id` value is the Account ID that most API paths take as `{account_id}`.

## Credits

The credit cost of this operation is not documented yet. See [API credits and pricing](https://www.forager.ai/docs/api-overview/credit-pricing.md).


## OpenAPI

````yaml GET /api/users/current/
openapi: 3.0.3
info:
  title: Forager public API
  version: 1.0.0
  description: Forager public API endpoints documentation
servers:
  - url: https://api-v2.forager.ai
security: []
tags:
  - name: Job Posts
    description: >-
      Search the Forager job-post index. Use these endpoints to find job
      postings by attributes such as title, location, posted date, or hiring
      organization, and to retrieve aggregate totals for a given query before
      paginating through full results.
  - name: Organizations
    description: >-
      Search the Forager organization index. Filter companies by attributes such
      as industry, headcount, location, keywords, and web technologies, and
      retrieve total match counts alongside the result set.
  - name: People
    description: >-
      Look up people and their records. Use the search endpoints to find people
      by role, employer, location, or skills, and the detail-lookup endpoints to
      fetch a full person record by ID, email, or phone number. Contact data has
      its own sections: Phones, Personal Emails, and Work Emails.
  - name: Phones
    description: >-
      Retrieve phone numbers for a known person. Provide identifying information
      (such as a LinkedIn handle or Forager ID) and get back the available phone
      numbers.
  - name: Personal Emails
    description: >-
      Retrieve personal email addresses for a known person. Returns addresses on
      free webmail / consumer providers (Gmail, Outlook, Yahoo, iCloud, Proton,
      and similar); corporate, educational, and other custom domains are
      excluded to keep deliverability high.
  - name: Work Emails
    description: >-
      Find and verify a person's work email address. Submit a lookup (single or
      bulk), poll the job for its result, and optionally receive the result by
      webhook when the job completes.
  - name: Websites
    description: >-
      Look up information about a website, including the organization that owns
      it and the technologies detected on the domain.
  - name: Users
    description: >-
      Manage your Forager account. Retrieve the current authenticated user,
      create and revoke API keys used to authenticate requests to the rest of
      the API, and review the credit balance-change log that records every
      lookup charge or adjustment against your account.
  - name: Autocomplete
    description: >-
      Resolve free-text input into the canonical IDs used elsewhere in the API.
      Each endpoint returns matching options for a search term (industries,
      organizations, organization keywords, locations, person skills, web
      technologies) so they can be passed as filters to the search endpoints.
  - name: Feedback
    description: >-
      Report verification feedback for contact data (phone numbers, personal
      emails, work emails) returned by Forager person lookups. Use these
      endpoints to submit whether a contact value is valid/invalid and whether
      it belongs to the matched person — every submission is stored as a new row
      and is used to improve the accuracy of future lookups.
paths:
  /api/users/current/:
    get:
      tags:
        - Users
      summary: View user information
      description: A view to retrieve current user details.
      operationId: users_current_retrieve
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
          description: ''
        '403':
          $ref: '#/components/responses/AuthenticationFailed'
      security:
        - Api-Key: []
components:
  schemas:
    User:
      type: object
      description: Account user serializer.
      properties:
        id:
          type: integer
          readOnly: true
        username:
          type: string
          description: >-
            Required. 150 characters or fewer. Letters, digits and @/./+/-/_
            only.
          pattern: ^[\w.@+-]+$
          maxLength: 150
        email:
          type: string
          format: email
          title: Email address
          maxLength: 254
        first_name:
          type: string
          maxLength: 150
        last_name:
          type: string
          maxLength: 150
        accounts:
          type: array
          items:
            $ref: '#/components/schemas/Account'
          readOnly: true
      required:
        - accounts
        - email
        - id
        - username
    Account:
      type: object
      description: Account serializer.
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          maxLength: 255
        subscription:
          allOf:
            - $ref: '#/components/schemas/Subscription'
          readOnly: true
      required:
        - id
        - name
        - subscription
    Subscription:
      type: object
      description: Subscription serializer.
      properties:
        id:
          type: integer
          readOnly: true
        is_active:
          type: boolean
          title: Is active?
        credits_balance:
          type: string
          format: decimal
          pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
          readOnly: true
        subscription_tier:
          allOf:
            - $ref: '#/components/schemas/SubscriptionTier'
          readOnly: true
        stripe_subscription_id:
          type: string
          nullable: true
          maxLength: 65
        stripe_subscription_price:
          allOf:
            - $ref: '#/components/schemas/StripeSubscriptionPrice'
          readOnly: true
      required:
        - credits_balance
        - id
        - stripe_subscription_price
        - subscription_tier
    SubscriptionTier:
      type: object
      description: Subscription tier serializer.
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          maxLength: 35
        person_details_lookup:
          type: string
          format: decimal
          pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
        person_work_email_lookup:
          type: string
          format: decimal
          pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
        person_personal_email_lookup:
          type: string
          format: decimal
          pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
        person_phone_number_lookup:
          type: string
          format: decimal
          pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
        person_reverse_email_search:
          type: string
          format: decimal
          pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
        person_reverse_phone_number_search:
          type: string
          format: decimal
          pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
        person_role_details_lookup:
          type: string
          format: decimal
          pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
        person_role_search_api_call:
          type: string
          format: decimal
          pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
        job_search_api_call:
          type: string
          format: decimal
          pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
        organization_search_api_call:
          type: string
          format: decimal
          pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
        organization_technologies_lookup:
          type: string
          format: decimal
          pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
        features:
          type: array
          items:
            $ref: '#/components/schemas/SubscriptionTierFeature'
          readOnly: true
        stripe_subscription_prices:
          type: array
          items:
            $ref: '#/components/schemas/StripeSubscriptionPrice'
          readOnly: true
      required:
        - features
        - id
        - name
        - stripe_subscription_prices
    StripeSubscriptionPrice:
      type: object
      description: Stripe subscription price serializer.
      properties:
        id:
          type: integer
          readOnly: true
        plan_price_usd:
          type: string
          format: decimal
          pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
          title: Plan price (USD)
        min_credits:
          type: integer
          maximum: 2147483647
          minimum: 0
        billing_cycle:
          $ref: '#/components/schemas/BillingCycleEnum'
      required:
        - id
    SubscriptionTierFeature:
      type: object
      description: Subscription tier feature serializer.
      properties:
        description:
          type: string
          maxLength: 255
      required:
        - description
    BillingCycleEnum:
      enum:
        - month
        - year
      type: string
      description: |-
        * `month` - Month
        * `year` - Year
  responses:
    AuthenticationFailed:
      description: >-
        The X-API-KEY header is missing, the key is not valid, or the key does
        not have permission for this resource.
      content:
        application/json:
          schema:
            type: object
            properties:
              detail:
                type: string
          example:
            detail: Authentication credentials were not provided.
  securitySchemes:
    Api-Key:
      type: apiKey
      in: header
      name: X-API-KEY

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.