Hourtick

Hourtick Chat API

Channels, DMs, threads, reactions, files and search. Message bodies are Markdown; reference things with links: `[#12 Title](hourtick://task/)`, `hourtick://project/`, `hourtick://client/`, `hourtick://entry/`, and mention with `[@Name](hourtick://user/)` or `hourtick://agent/`. `[@all](hourtick://user/all)` mentions everyone in a channel (not in DMs; managers and admins only beyond 50 people; people can mute it per channel; it never starts agents). Pages come with `refs`: live data for every referenced task, project, client and time entry.

GitHub OpenAPI
Business capability
In-App Chat AE-150.40

Operations 21

GET /api/v1/chat/channels Your channels and DMs with unread and mention counts. #
POST /api/v1/chat/channels Create a channel (name is slugged; private channels need `memberIds`) #
PATCH /api/v1/chat/channels/{id} Rename, set the topic or archive #
POST /api/v1/chat/channels/{id}/join Join a public channel #
GET /api/v1/gifs GIFs for the chat picker (Powered by GIPHY) #
PATCH /api/v1/chat/channels/{id}/preferences Your preferences for a channel #
POST /api/v1/chat/channels/{id}/leave Leave a channel #
POST /api/v1/chat/channels/{id}/members Add people and agents #
POST /api/v1/chat/channels/{id}/read Mark the channel read #
GET /api/v1/chat/channels/{id}/messages 50 top-level messages, newest last, with `refs`. #
POST /api/v1/chat/channels/{id}/messages Post a message (`parentId` replies in a thread; `attachmentIds` links uploaded… #
POST /api/v1/chat/channels/{id}/files Upload a file (multipart/form-data, field `file`, up to 25 MB), then send its… #
GET /api/v1/chat/files/{id} Redirects to a 5-minute signed URL; `?download=1` forces a download #
POST /api/v1/chat/dms Open (or reuse) a DM with one or more people and agents #
PATCH /api/v1/chat/messages/{id} Edit your message #
DELETE /api/v1/chat/messages/{id} Delete a message and its files (author or managers) #
POST /api/v1/chat/messages/{id}/reactions Toggle an emoji reaction #
POST /api/v1/chat/messages/{id}/task Turn a message into a task; a reply links to it #
POST /api/v1/chat/typing Say you're typing (shown for 5 seconds) #
GET /api/v1/chat/search Full-text search in messages you can read #
GET /api/v1/presence Who's online, what they're tracking (if they share it) and which agents are… #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/hourtick/openapi/hourtick-chat-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/hourtick/json-schema/hourtick-time-entry-schema.json
📊
JSONSchema
https://artifacts.apis.io/hourtick/json-schema/hourtick-work-item-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/hourtick:hourtick-chat-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

hourtick-chat-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Hourtick Chat API
  version: 1.0.0
  description: 'The Hourtick REST API. Authenticate with a personal API token: create one in **Settings → API tokens**, then send `Authorization: Bearer ht_…`.


    All timer changes go through **POST /api/v1/commands**, the same endpoint the web and Mac apps use. Commands are idempotent per `commandId` (use a new UUID per action, reuse it to retry safely).


    Every response carries a `Server-Time` header (epoch ms). Errors use RFC 9457 problem details.'
servers:
- url: https://hourtick.com
security:
- bearer: []
tags:
- name: Chat
  description: 'Channels, DMs, threads, reactions, files and search. Message bodies are Markdown; reference things with links: `#12 Title`, `hourtick://project/`, `hourtick://client/`, `hourtick://entry/`, and mention with `@Name` or `hourtick://agent/`. `@all` mentions everyone in a channel (not in DMs; managers and admins only beyond 50 people; people can mute it per channel; it never starts agents). Pages come with `refs`: live data for every referenced task, project, client and time entry.'
paths:
  /api/v1/chat/channels:
    get:
      tags:
      - Chat
      summary: Your channels and DMs with unread and mention counts.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      operationId: getApiV1ChatChannels
      x-operation-id-source: derived
    post:
      tags:
      - Chat
      summary: Create a channel (name is slugged; private channels need `memberIds`)
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 60
                topic:
                  type: string
                  maxLength: 250
                isPrivate:
                  type: boolean
                memberIds:
                  maxItems: 500
                  type: array
                  items:
                    type: string
                    minLength: 1
                    maxLength: 100
              required:
              - name
              additionalProperties: false
      responses:
        '201':
          description: OK
          content:
            application/json:
              schema:
                type: object
        '409':
          description: Name taken
      operationId: postApiV1ChatChannels
      x-operation-id-source: derived
  /api/v1/chat/channels/{id}:
    patch:
      tags:
      - Chat
      summary: Rename, set the topic or archive
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 60
                topic:
                  type: string
                  maxLength: 250
                archived:
                  type: boolean
              additionalProperties: false
      responses:
        '204':
          description: Saved
      operationId: patchApiV1ChatChannelsById
      x-operation-id-source: derived
  /api/v1/chat/channels/{id}/join:
    post:
      tags:
      - Chat
      summary: Join a public channel
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Joined
      operationId: postApiV1ChatChannelsByIdJoin
      x-operation-id-source: derived
  /api/v1/gifs:
    get:
      tags:
      - Chat
      summary: GIFs for the chat picker (Powered by GIPHY)
      description: Trending when `q` is empty, otherwise a search (rated G). Post one as a message body of `!title`; only GIPHY media URLs render as images. 503 when the server has no GIPHY key.
      parameters:
      - name: q
        in: query
        schema:
          type: string
          maxLength: 50
      - name: offset
        in: query
        schema:
          type: integer
          minimum: 0
      responses:
        '200':
          description: 'Up to 24 GIFs: id, title, preview (+ size), url (+ width, height)'
        '503':
          description: GIFs aren't set up
      operationId: getApiV1Gifs
      x-operation-id-source: derived
  /api/v1/chat/channels/{id}/preferences:
    patch:
      tags:
      - Chat
      summary: Your preferences for a channel
      description: '`muteAll: true` stops `@all` from mentioning you in this channel. Direct mentions still reach you.'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - muteAll
              properties:
                muteAll:
                  type: boolean
      responses:
        '204':
          description: Saved
      operationId: patchApiV1ChatChannelsByIdPreferences
      x-operation-id-source: derived
  /api/v1/chat/channels/{id}/leave:
    post:
      tags:
      - Chat
      summary: Leave a channel
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Left
      operationId: postApiV1ChatChannelsByIdLeave
      x-operation-id-source: derived
  /api/v1/chat/channels/{id}/members:
    post:
      tags:
      - Chat
      summary: Add people and agents
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              properties:
                userIds:
                  default: []
                  maxItems: 500
                  type: array
                  items:
                    type: string
                    minLength: 1
                    maxLength: 100
                agentIds:
                  default: []
                  maxItems: 50
                  type: array
                  items:
                    type: string
                    format: uuid
                    pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
      responses:
        '204':
          description: Added
      operationId: postApiV1ChatChannelsByIdMembers
      x-operation-id-source: derived
  /api/v1/chat/channels/{id}/read:
    post:
      tags:
      - Chat
      summary: Mark the channel read
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Read
      operationId: postApiV1ChatChannelsByIdRead
      x-operation-id-source: derived
  /api/v1/chat/channels/{id}/messages:
    get:
      tags:
      - Chat
      summary: 50 top-level messages, newest last, with `refs`.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: before
        in: query
        schema:
          type: string
          format: uuid
      - name: thread
        in: query
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      operationId: getApiV1ChatChannelsByIdMessages
      x-operation-id-source: derived
    post:
      tags:
      - Chat
      summary: Post a message (`parentId` replies in a thread; `attachmentIds` links uploaded…
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              properties:
                body:
                  type: string
                  maxLength: 20000
                parentId:
                  anyOf:
                  - type: string
                    format: uuid
                    pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                  - type: 'null'
                attachmentIds:
                  default: []
                  maxItems: 20
                  type: array
                  items:
                    type: string
                    format: uuid
                    pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
              required:
              - body
      responses:
        '201':
          description: OK
          content:
            application/json:
              schema:
                type: object
      operationId: postApiV1ChatChannelsByIdMessages
      x-operation-id-source: derived
  /api/v1/chat/channels/{id}/files:
    post:
      tags:
      - Chat
      summary: Upload a file (multipart/form-data, field `file`, up to 25 MB), then send its…
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
              required:
              - file
      responses:
        '201':
          description: OK
          content:
            application/json:
              schema:
                type: object
        '402':
          description: This month's usage is used up; uploads pause until the 1st
        '413':
          description: File too large
      operationId: postApiV1ChatChannelsByIdFiles
      x-operation-id-source: derived
  /api/v1/chat/files/{id}:
    get:
      tags:
      - Chat
      summary: Redirects to a 5-minute signed URL; `?download=1` forces a download
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '302':
          description: Signed URL
      operationId: getApiV1ChatFilesById
      x-operation-id-source: derived
  /api/v1/chat/dms:
    post:
      tags:
      - Chat
      summary: Open (or reuse) a DM with one or more people and agents
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              properties:
                userIds:
                  default: []
                  maxItems: 20
                  type: array
                  items:
                    type: string
                    minLength: 1
                    maxLength: 100
                agentIds:
                  default: []
                  maxItems: 10
                  type: array
                  items:
                    type: string
                    format: uuid
                    pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      operationId: postApiV1ChatDms
      x-operation-id-source: derived
  /api/v1/chat/messages/{id}:
    patch:
      tags:
      - Chat
      summary: Edit your message
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              properties:
                body:
                  type: string
                  minLength: 1
                  maxLength: 20000
              required:
              - body
      responses:
        '204':
          description: Saved
      operationId: patchApiV1ChatMessagesById
      x-operation-id-source: derived
    delete:
      tags:
      - Chat
      summary: Delete a message and its files (author or managers)
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Deleted
      operationId: deleteApiV1ChatMessagesById
      x-operation-id-source: derived
  /api/v1/chat/messages/{id}/reactions:
    post:
      tags:
      - Chat
      summary: Toggle an emoji reaction
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              properties:
                emoji:
                  type: string
                  minLength: 1
                  maxLength: 16
              required:
              - emoji
      responses:
        '204':
          description: Toggled
      operationId: postApiV1ChatMessagesByIdReactions
      x-operation-id-source: derived
  /api/v1/chat/messages/{id}/task:
    post:
      tags:
      - Chat
      summary: Turn a message into a task; a reply links to it
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '201':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  item:
                    $ref: '#/components/schemas/WorkItem'
      operationId: postApiV1ChatMessagesByIdTask
      x-operation-id-source: derived
  /api/v1/chat/typing:
    post:
      tags:
      - Chat
      summary: Say you're typing (shown for 5 seconds)
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              properties:
                channelId:
                  type: string
                  format: uuid
                  pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                parentId:
                  anyOf:
                  - type: string
                    format: uuid
                    pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                  - type: 'null'
              required:
              - channelId
      responses:
        '204':
          description: Sent
      operationId: postApiV1ChatTyping
      x-operation-id-source: derived
  /api/v1/chat/search:
    get:
      tags:
      - Chat
      summary: Full-text search in messages you can read
      parameters:
      - name: q
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      operationId: getApiV1ChatSearch
      x-operation-id-source: derived
  /api/v1/presence:
    get:
      tags:
      - Chat
      summary: Who's online, what they're tracking (if they share it) and which agents are…
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      operationId: getApiV1Presence
      x-operation-id-source: derived
components:
  schemas:
    WorkItem:
      type: object
      description: 'A task. Status: todo | in_progress | review | done. Priority: 0 none … 4 urgent. `description` (in the detail and in writes) is Markdown, including `- [ ]` checklists.'
      properties:
        id:
          type: string
          format: uuid
        number:
          type: integer
          description: 'Short number shown as #12'
        title:
          type: string
        status:
          type: string
          enum:
          - todo
          - in_progress
          - review
          - done
        priority:
          type: integer
          minimum: 0
          maximum: 4
        projectId:
          type:
          - string
          - 'null'
        clientId:
          type:
          - string
          - 'null'
        dueDate:
          type:
          - string
          - 'null'
          format: date
        estimateSeconds:
          type:
          - integer
          - 'null'
        labels:
          type: array
          items:
            type: string
        position:
          type: number
        assigneeIds:
          type: array
          items:
            type: string
        trackedSeconds:
          type: integer
        runningUserIds:
          type: array
          items:
            type: string
        commentCount:
          type: integer
        attachmentCount:
          type: integer
        checklistDone:
          type: integer
        checklistTotal:
          type: integer
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: ht_… personal API token