get

GET

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

GET

/api/v1/customer

from groundx import GroundX
client = GroundX(
    api_key="YOUR_API_KEY_HERE",
)
client.customer.get()

200Retrieved

{
  "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
  }
}

Get the account information associated with the API key.

Authentication

X-API-Keystring

API Key authentication via header

Response

Lookup successful

customerobject

Account information for the user