Quickstart

This guide walks you through making your first request to the ywork API.

1. Get an API key

Sign in to your workspace, open Settings → API keys, and create a new key. Copy it somewhere safe — the secret is shown only once. Keys look like this:

ywork_sk_live_2f8c1b9a4d7e6031

Treat your API key like a password. Never commit it to source control or expose it in client-side code.

2. Set the base URL

All endpoints live under a single, versioned base URL:

https://docs.ywork.dev/api/v1

3. Make a request

Every request must be made over HTTPS and include your API key as a bearer token in the Authorization header. The /users/me endpoint is the simplest way to verify that your key works:

curl https://docs.ywork.dev/api/v1/users/me \
  -H "Authorization: Bearer ywork_sk_live_2f8c1b9a4d7e6031"

A successful response returns the user associated with the key:

{
  "id": "usr_3Jk2mQ8zpL",
  "object": "user",
  "email": "ada@example.com",
  "name": "Ada Lovelace",
  "role": "admin",
  "created_at": "2025-11-02T09:14:33Z"
}

4. Create something

Create a project, then add a task to it:

curl -X POST https://docs.ywork.dev/api/v1/projects \
  -H "Authorization: Bearer ywork_sk_live_2f8c1b9a4d7e6031" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Website redesign", "key": "WEB" }'

Next steps

• Read the Authentication guide.
• Learn how list endpoints page results in Pagination.
• Browse the full API Reference.