Skip to content
ywork API

Overview

ywork API 1.0.0

Section titled “ywork API 1.0.0”

The ywork API is a REST API for programmatic access to your ywork workspace — projects, tasks, users and webhooks.

The API is organised around predictable, resource-oriented URLs, returns JSON-encoded responses, and uses standard HTTP status codes, verbs and authentication.

All requests must be made over HTTPS. Requests made over plain HTTP are refused. Authentication is performed with a bearer token — see the Authentication guide.

Operations

Section titled “Operations”
GET
/users/me
GET
/users
GET
/projects
POST
/projects
GET
/projects/{projectId}
DELETE
/projects/{projectId}
PATCH
/projects/{projectId}
GET
/projects/{projectId}/tasks
POST
/projects/{projectId}/tasks
GET
/tasks/{taskId}
DELETE
/tasks/{taskId}
PATCH
/tasks/{taskId}
GET
/webhooks
POST
/webhooks
DELETE
/webhooks/{webhookId}

Authentication

Section titled “Authentication”

bearerAuth

Section titled “bearerAuth”

Authenticate by sending your secret API key as a bearer token in the Authorization header: Authorization: Bearer ywork_sk_....

Security scheme type: http

Bearer format: API key