# Getting started

Source: https://www.geardex.app/api-docs/getting-started

API access requires the GearDex Studio plan and a scoped Studio API key.

Set up your first Studio API integration in minutes with secure key management defaults.

## Prerequisites

- [Studio subscription](https://www.geardex.app/pricing) with API access enabled
- An external agent runtime (Claude Desktop, Cursor, custom app, etc.)
- Secure environment variable storage for credentials

## Create an API key

1. [Sign in](https://www.geardex.app/signin) and open **Settings**, then **API & Agents**.
2. Click `Create API key`.
3. Pick only required [scopes](https://www.geardex.app/api-docs/scopes). Available: `gear:read`, `gear:write`, `shoots:read`, `shoots:write`, `maintenance:read`, `maintenance:write`, `documents:read`, `analytics:read`, `profile:read`, `loans:read`, `loans:write`, `bookings:read`, `bookings:write`, `money:read`, `money:write`.
4. Set an expiration window and save the key securely.

## First request

Send the key as a bearer token. This returns your three most recent gear records. See [Authentication](https://www.geardex.app/api-docs/authentication) for a JavaScript version.

**Request (cURL)**

```bash
curl -X GET "https://www.geardex.app/api/studio-agent/v1/gear?limit=3" \
  -H "Authorization: Bearer gdx_live_your_key_here" \
  -H "Accept: application/json"
```

## Secure storage

Keep keys server-side

Never place API keys in frontend bundles or checked-in code. Store keys in environment variables, secret managers, or encrypted runtime settings.

**.env example**

```env
GEARDEX_BASE_URL=https://www.geardex.app
GEARDEX_STUDIO_API_KEY=gdx_live_your_key_here
```

## Rotation and revocation

Rotate keys proactively and revoke immediately if an integration is no longer needed or you suspect exposure.

- Use one key per integration.
- Prefer expiring keys over permanent keys.
- Review API [activity logs](https://www.geardex.app/api-docs/audit-logs) in Settings regularly.