# API overview

> The Stackly API is a REST API over HTTPS that returns JSON. The base path is /api/v1. Every plan includes API access. Official SDKs exist for TypeScript, Python and Go. Authenticate with a bearer toke

Source: https://stacklyhq.xyz/docs/api-reference/overview

## Getting started

- [Quickstart](https://stacklyhq.xyz/docs/getting-started/quickstart)
- [Create a workspace](https://stacklyhq.xyz/docs/getting-started/create-a-workspace)
- [Invite your team](https://stacklyhq.xyz/docs/getting-started/invite-your-team)
- [Import from CSV](https://stacklyhq.xyz/docs/getting-started/import-from-csv)

## Concepts

- [Workspaces and projects](https://stacklyhq.xyz/docs/concepts/workspaces-and-projects)
- [Tasks and subtasks](https://stacklyhq.xyz/docs/concepts/tasks-and-subtasks)
- [Statuses and workflows](https://stacklyhq.xyz/docs/concepts/statuses-and-workflows)
- [Labels and priorities](https://stacklyhq.xyz/docs/concepts/labels-and-priorities)
- [Roles and permissions](https://stacklyhq.xyz/docs/concepts/roles-and-permissions)

## API reference

- **API overview**
- [Authentication](https://stacklyhq.xyz/docs/api-reference/authentication)
- [Pagination](https://stacklyhq.xyz/docs/api-reference/pagination)
- [Errors](https://stacklyhq.xyz/docs/api-reference/errors)
- [Tasks API](https://stacklyhq.xyz/docs/api-reference/tasks)
- [Projects API](https://stacklyhq.xyz/docs/api-reference/projects)
- [Comments API](https://stacklyhq.xyz/docs/api-reference/comments)
- [Users API](https://stacklyhq.xyz/docs/api-reference/users)
- [Stackly API reference (complete)](https://stacklyhq.xyz/docs/api-reference/full)

## Webhooks

- [Webhooks overview](https://stacklyhq.xyz/docs/webhooks/overview)
- [Webhook events](https://stacklyhq.xyz/docs/webhooks/events)
- [Webhook signatures](https://stacklyhq.xyz/docs/webhooks/signatures)
- [Webhook retries](https://stacklyhq.xyz/docs/webhooks/retries)

## SDKs

- [TypeScript SDK](https://stacklyhq.xyz/docs/sdks/typescript)
- [Python SDK](https://stacklyhq.xyz/docs/sdks/python)
- [Go SDK](https://stacklyhq.xyz/docs/sdks/go)

## Security

- [Security overview](https://stacklyhq.xyz/docs/security/overview)
- [Single sign-on](https://stacklyhq.xyz/docs/security/sso)
- [Data retention](https://stacklyhq.xyz/docs/security/data-retention)

## Limits

- [Plan limits](https://stacklyhq.xyz/docs/limits/plan-limits)
- [Rate limits](https://stacklyhq.xyz/docs/limits/rate-limits)

1. [Docs](https://stacklyhq.xyz/docs)
2. API reference
3. API overview

# API overview

The Stackly API is a REST API over HTTPS that returns JSON. The base path is /api/v1. Every plan includes API access. Official SDKs exist for TypeScript, Python and Go. Authenticate with a bearer token, described in Authentication.

## Details

- All requests are made over HTTPS to the base path /api/v1, and every response is JSON.
- Send Content-Type: application/json on requests that have a body.
- Each response includes a request_id; quote it when you contact support.
- Timestamps are ISO 8601 in UTC, and identifiers are opaque strings.
- Write requests accept an Idempotency-Key header, so a retried request does not create a duplicate.
- Rate limits are per workspace per minute, and the response headers show how many requests remain.
- The SDKs for TypeScript, Python and Go wrap these calls and handle pagination for you.
- Fields not listed on this page are ignored on write and may be added to responses later.
- All requests are made over HTTPS to the base path /api/v1, and every response is JSON. (API overview, note 2.)
- Send Content-Type: application/json on requests that have a body. (API overview, note 2.)
- Each response includes a request_id; quote it when you contact support. (API overview, note 2.)
- Timestamps are ISO 8601 in UTC, and identifiers are opaque strings. (API overview, note 2.)
- Write requests accept an Idempotency-Key header, so a retried request does not create a duplicate. (API overview, note 2.)
- Rate limits are per workspace per minute, and the response headers show how many requests remain. (API overview, note 2.)
- The SDKs for TypeScript, Python and Go wrap these calls and handle pagination for you. (API overview, note 2.)
- Fields not listed on this page are ignored on write and may be added to responses later. (API overview, note 2.)
- All requests are made over HTTPS to the base path /api/v1, and every response is JSON. (API overview, note 3.)
- Send Content-Type: application/json on requests that have a body. (API overview, note 3.)

Every plan includes the Stackly API, so the steps on this page work on Free, Pro and Business.

## See also

- [Authentication](https://stacklyhq.xyz/docs/api-reference/authentication)
- [Webhooks overview](https://stacklyhq.xyz/docs/webhooks/overview)

Next: [Authentication](https://stacklyhq.xyz/docs/api-reference/authentication)