> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.eyelevel.ai/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.eyelevel.ai/_mcp/server.

# get

GET https://api.groundx.ai/api/v1/customer

Get the account information associated with the API key.


Reference: https://docs.eyelevel.ai/reference/api-reference/customer/get

## Authentication

- `X-API-Key` header (required) — API Key authentication via header

## Response

### 200

Lookup successful

- `customer` (CustomerDetail, required) — Account information for the user

## Types

### CustomerDetail

Account information for the user

- `fileAccess` (FileAccessPolicy, optional, nullable) — Applied settings for this resource. Null means it inherits settings. Deployments without file access omit this field. Pending changes are not returned.
- `effectiveFileAccess` (EffectivePolicy, optional) — Applied settings after inheritance. Sharing links expire after 300 seconds by default; storage credentials may shorten that time. Protected stable URLs require current authentication on every read.
- `email` (string, optional) — Email associated with the account
- `first` (string, optional) — Given name associated with the account, if known
- `last` (string, optional) — Family name associated with the account, if known
- `status` (enum, optional) — Account status associated with the customer, if known
  - Allowed values: `admin`, `apiKey`, `archived`, `invalid`, `partnerApiKey`, `partnerModUser`, `partner`, `test`, `user`
- `subscription` (SubscriptionDetail, optional) — Subscription information for the user, including current usage and limits
- `fileAccessRevision` (integer, optional, deprecated) — Legacy compatibility field. Not required or checked when changing file access.

### FileAccessPolicy

For each field, document settings take priority over bucket settings, then account settings. Omitted fields use the broader value. Explicit public mode and longer sharing lifetimes are allowed. Stable public links never expire. urlTtlSeconds limits new sharing links; an issued link works without API credentials until its storage expiry.

- `mode` (enum, optional)
  - Allowed values: `public`, `protected`
- `urlTtlSeconds` (integer, optional)

### EffectivePolicy

Applied settings after inheritance. Sharing links expire after 300 seconds by default; storage credentials may shorten that time. Protected stable URLs require current authentication on every read.

- `mode` (enum, required)
  - Allowed values: `public`, `protected`
- `urlTtlSeconds` (integer, required)

### SubscriptionDetail

Subscription information for the user, including current usage and limits

- `billingCycleAnchor` (string, optional) — Billing cycle anchor for the current subscription.
- `billingStart` (string, optional) — Start of the billing period used for current usage values.
- `billingEnd` (string, optional) — End of the billing period used for current usage values, when available.
- `meters` (SubscriptionDetailMeters, optional)

### SubscriptionDetailMeters

- `fileTokens` (MeterDetail, optional) — Current usage and limits for the user for the given metric
- `searches` (MeterDetail, optional) — Current usage and limits for the user for the given metric

### MeterDetail

Current usage and limits for the user for the given metric

- `max` (integer, optional) — Maximum limit for the current billing period
- `meterId` (string, optional) — Unique usage metric ID.
- `value` (integer, optional) — Current usage for the current billing period

## Examples

**Response**

```json
{
  "customer": {
    "fileAccess": {
      "mode": "public",
      "urlTtlSeconds": 1
    },
    "effectiveFileAccess": {
      "mode": "public",
      "urlTtlSeconds": 1
    },
    "email": "string",
    "first": "string",
    "last": "string",
    "status": "admin",
    "subscription": {
      "billingCycleAnchor": "2024-01-15T09:30:00Z",
      "billingStart": "2024-01-15T09:30:00Z",
      "billingEnd": "2024-01-15T09:30:00Z",
      "meters": {
        "fileTokens": {
          "max": 1,
          "meterId": "string",
          "value": 1
        },
        "searches": {
          "max": 1,
          "meterId": "string",
          "value": 1
        }
      }
    },
    "fileAccessRevision": 1
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.groundx.ai/api/v1/customer"

headers = {"X-API-Key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.groundx.ai/api/v1/customer';
const options = {method: 'GET', headers: {'X-API-Key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.groundx.ai/api/v1/customer"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.groundx.ai/api/v1/customer")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.groundx.ai/api/v1/customer")
  .header("X-API-Key", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.groundx.ai/api/v1/customer', [
  'headers' => [
    'X-API-Key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.groundx.ai/api/v1/customer");
var request = new RestRequest(Method.GET);
request.AddHeader("X-API-Key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["X-API-Key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.groundx.ai/api/v1/customer")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```