Quickstart

Make your first authenticated Well API call in under five minutes.

Get from zero to your first response in three steps.

1. Get an API key

Create an API key for your workspace (see Authentication). Treat it like a password — it carries your workspace scope.

export WELL_API_KEY="sk_live_…"

2. Make your first call

List the companies in your workspace:

curl https://api.wellapp.ai/v1/companies \
  -H "Authorization: Bearer $WELL_API_KEY"

You get a JSON:API response — data plus pagination in meta/links:

{
  "data": [ { "type": "company", "id": "co_1", "attributes": { "name": "Acme" } } ],
  "meta": { "total": 128, "count": 20 },
  "links": { "next": "eyJpZCI6MjB9" }
}

3. Page, filter, create

  • Next page: pass the previous links.next as ?cursor= (see Conventions → Pagination).
  • Filter / target a workspace: add ?workspaceId=<uuid> to scope to a specific workspace you belong to.
  • Create: POST a JSON:API body — e.g. create a task:
curl -X POST https://api.wellapp.ai/v1/tasks \
  -H "Authorization: Bearer $WELL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "data": { "type": "tasks", "attributes": { "title": "Chase invoice #1042", "executor_type": "human" } } }'

Next steps