GearDex DocsPlatform API
Scopes
Scopes keep every GearDex integration narrow, understandable, and easy to revoke without affecting the rest of your workflow.
Studio APIv1Updated August 2026
GearDexStudio consoleLive workspace
Access policy
Least-privilege scope matrix
ResourceReadWrite
Gear
Shoots
Maintenance
Documents
Analytics
Scope model
A key can include multiple scopes. Every endpoint declares the scope it requires, and GearDex checks that permission before accessing account data. Read access never implies write access.
Available scopes
| Name | Type | Description |
|---|---|---|
gear:read | read scope | Read inventory records and filtered gear lists. |
gear:write | write scope | Create, update, and delete owned inventory records. |
shoots:read | read scope | Read shoot plans, dates, status, locations, and progress. |
shoots:write | write scope | Create, update, and delete shoot plans. |
maintenance:read | read scope | Read service records, schedules, providers, and cost. |
maintenance:write | write scope | Create, update, and delete service records for owned gear. |
documents:read | read scope | Read document metadata and warranty timelines. |
analytics:read | read scope | Read portfolio-level inventory and operations summaries. |
profile:read | read scope | Read account and Studio profile metadata. |
Recommended scope sets
| Name | Type | Description |
|---|---|---|
Inventory reporter | gear:read + analytics:read | Summarize inventory composition and portfolio totals without making changes. |
Production briefing | shoots:read + gear:read + maintenance:read | Assess upcoming work, available equipment, and service conflicts. |
Warranty monitor | documents:read + gear:read | Associate coverage timelines with the affected equipment. |
Service queue sync | maintenance:read + maintenance:write + gear:read | Create and update repair records while validating owned gear references. |
Shoot planning automation | shoots:read + shoots:write + gear:read | Draft and maintain production plans using live inventory context. |
Missing scope errors
A valid key that lacks the endpoint's required permission receives a403 response. Create or update a purpose-specific key instead of broadening unrelated integrations.
403 response
{
"error": "This API key does not include the required scope",
"code": "insufficient_scope",
"required_scope": "maintenance:write"
}