> ## Documentation Index
> Fetch the complete documentation index at: https://guides.affiliate.com/llms.txt
> Use this file to discover all available pages before exploring further.

# GET /v1/account — retrieve account information

> Fetch your team's name, API rate limit, request counters, and per-product billing cycle data using your Bearer token. Returns team ID and product list.

Use this endpoint to retrieve account details for the team associated with your bearer token. The response includes your team identity, rate limit configuration, and a breakdown of request usage per product.

## Endpoint

```
GET /v1/account
```

## Request

This endpoint takes no query parameters or request body. You only need to supply your `Authorization` header.

### Headers

<ParamField header="Authorization" type="string" required>
  Your bearer token in the format `Bearer <token>`. All requests to the Affiliate.com API require this header.
</ParamField>

### Example request

```bash theme={null}
curl --location --request GET 'https://api.affiliate.com/v1/account' \
--header 'Authorization: Bearer {{token}}'
```

## Responses

### 200 — Success

Returns a JSON object with your team details, usage statistics, and product billing information.

<ResponseField name="team_id" type="integer">
  The unique identifier for your team.
</ResponseField>

<ResponseField name="team_name" type="string">
  The display name of your team.
</ResponseField>

<ResponseField name="api_request_rate_limit" type="integer">
  The maximum number of API requests your team can make per minute.
</ResponseField>

<ResponseField name="can_toggle_short_url" type="boolean">
  Whether your team has permission to toggle short URL generation.
</ResponseField>

<ResponseField name="product_search_results_max" type="integer">
  The maximum number of product search results returnable per query.
</ResponseField>

<ResponseField name="requests_total_so_far" type="integer">
  The total number of API requests your team has made.
</ResponseField>

<ResponseField name="requests_made_since_last_payment" type="integer">
  The number of API requests made since your most recent payment.
</ResponseField>

<ResponseField name="products" type="array">
  The products your bearer token has active. Each entry includes a request count and optional billing cycle.

  <Expandable title="products[]">
    <ResponseField name="product" type="string">
      The product identifier. Currently `"API"`.
    </ResponseField>

    <ResponseField name="count" type="integer">
      The number of requests made against this product in the current billing cycle.
    </ResponseField>

    <ResponseField name="billing_cycle" type="object | null">
      The billing window for this product. Returns `null` if billing does not apply to this product.

      <Expandable title="billing_cycle">
        <ResponseField name="start" type="string">
          ISO 8601 timestamp marking the start of the billing cycle.
        </ResponseField>

        <ResponseField name="end" type="string">
          ISO 8601 timestamp marking the end of the billing cycle.
        </ResponseField>

        <ResponseField name="days_remaining" type="integer">
          The number of days remaining in the current billing cycle.
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="meta" type="object">
  Metadata about the response.

  <Expandable title="meta">
    <ResponseField name="trace_id" type="string">
      A unique trace identifier for this request, useful when contacting support.
    </ResponseField>
  </Expandable>
</ResponseField>

#### Example response

```json theme={null}
{
    "team_id": 10,
    "team_name": "Test Team",
    "api_request_rate_limit": 60,
    "can_toggle_short_url": false,
    "product_search_results_max": 10000,
    "requests_total_so_far": 5,
    "requests_made_since_last_payment": 5,
    "products": [
        {
            "product": "API",
            "count": 1234,
            "billing_cycle": {
                "start": "2025-06-15T15:22:35+00:00",
                "end": "2025-07-15T15:22:35+00:00",
                "days_remaining": 0
            }
        }
    ],
    "meta": {
        "trace_id": "01980eae-de82-72de-8402-cd5ad0588cee"
    }
}
```

### 401 — Unauthenticated

Your bearer token is missing, expired, or invalid. Verify that you are passing the correct token in the `Authorization` header.

### 429 — Rate Limit Exceeded

You have exceeded your team's `api_request_rate_limit`. Wait until the next minute window before retrying.
