---
title: Using the GigBook API
id: using-the-api
description: Read and update clients, events, checklists, and planning over a simple REST API authenticated with an org API key.
category: Developers
order: 40
tags: [api, integrations, developers]
related: [checklist-and-forms]
updated: 2026-06-30
---

GigBook has a REST API for reading and updating your clients, events, checklists, and
planning forms — handy for integrations, automations, or syncing with another system.

## Get an API key

Each key is scoped to a single organization. Ask us to issue one for your workspace.
Treat it like a password — it's shown once and grants full access to your org's data.

## Authenticate

Send your key as a Bearer token on every request:

```bash
curl https://djgigbook.com/api/v1/me \
  -H "Authorization: Bearer YOUR_API_KEY"
```

`GET /api/v1/me` returns the org your key belongs to — a quick way to confirm it works.

## What you can do

| Resource | Operations |
|---|---|
| Clients | list, create, get, update, delete |
| Events | list (filter by status / client / date), create, get, update, delete |
| Checklist | list, add, update, delete items |
| Planning | get, upsert the planning form |

Responses are wrapped as `{ "data": … }`; errors as `{ "error": { "code", "message" } }`.

## Checklist completion over the API

A bound checklist item (contract, deposit, planning…) reports `completed: true` when its
real task is done — even if it was never ticked by hand. The `completed_at` field reflects
only a manual override. See [Checklists & forms](/checklist-and-forms) for the model.

## Full reference

The complete, interactive API reference (every endpoint, request/response shapes, and a
"try it" console) lives at **[djgigbook.com/docs](https://djgigbook.com/docs)**, generated
from the live OpenAPI spec at `/api/v1/openapi.json`.

## Checklist

- [ ] Request an API key for your workspace
- [ ] Confirm it with `GET /api/v1/me`
- [ ] Explore the full reference at /docs
- [ ] Build your integration