← Help center · Account & team

The Atwork API

Updated Oct 8, 2026

Everything the app does, it does through a REST API you can call yourself.

Base URL and auth

https://api.atwork.so

Routes are versioned, so paths start with /v1/. Authenticate with a bearer token on every request:

Authorization: Bearer YOUR_TOKEN

Create a token under Profile settings → API tokens. It carries your access — see API tokens.

Sheets

PurposeCall
List sheetsGET /v1/sheets
Get one sheet, with its attributesGET /v1/sheets/:sheetId
Create a sheetPOST /v1/sheets
The available field typesGET /v1/sheets/data-types

Fetching a sheet returns its attributes — that is where you find the field ids and codes you need for everything else.

Items

PurposeCall
Read itemsPOST /v1/sheets/:sheetId/get-items
Create an itemPOST /v1/sheets/:sheetId/items
Update an itemPATCH /v1/sheets/:sheetId/items/:itemId
Delete an itemDELETE /v1/sheets/:sheetId/items/:itemId
Duplicate itemsPOST /v1/sheets/:sheetId/items/duplicate

Reading items is a POST, not a GET — the filter, sort and pagination go in the request body, which would not fit sensibly in a query string. That surprises people, so it is worth stating plainly.

Fields and views

PurposeCall
Add a fieldPOST /v1/sheets/:sheetId/attributes
Update a fieldPATCH /v1/sheets/:sheetId/attributes/:attrId
Add an option to a select fieldPOST /v1/sheets/attribute-options/:attrId
Create a viewPOST /v1/sheets/:sheetId/view

Other areas

The same pattern covers the rest of the product — /v1/agents, /v1/calendars, /v1/dashboards, /v1/notifications, /v1/page, /v1/integrations, /v1/availability and more.

Practical notes

  • A token acts as you. Anything you can see and change, it can.
  • Read a sheet first to learn its attribute codes rather than hard-coding guesses; codes are generated and are not the display names.
  • Page through large sheets using the filter body instead of pulling everything.
  • Be considerate with volume. Some public endpoints are rate limited; hammering the API in a loop is a good way to get an unhappy response.

Prefer to just ask?

If you want an AI assistant to work with your workspace rather than writing code, use the MCP server instead — see Use Atwork from an AI assistant.

Related: API tokens · Use Atwork from an AI assistant (MCP)

Related articles

Who can see a dashboard?
An Atwork dashboard is a Charts view on a sheet and follows the sheet's access: who can open it, who sees which numbers, and who can create or delete it.
Members, guests and portal users
Atwork has three kinds of people: members, guests and portal users. See who signs in, what each can see, and who takes a paid seat.
Organization settings
Change your Atwork workspace name, logo, default language, calendar and start of week, and manage locations. Only the workspace owner can do this.