Documentation
Documentation
https://www.tines.com/api/welcome/
Authentication
https://www.tines.com/api/authentication/
RateLimits
https://www.tines.com/api/api-rate-limits/
OpenAPI Specification
openapi: 3.0.3
info:
title: Tines REST Actions Tags API
description: The Tines REST API provides programmatic access to all platform resources including stories (workflows), actions, credentials, teams, folders, cases, records, dashboards, audit logs, SCIM provisioning, AI usage tracking, reporting, tags, and the workbench. The API uses API key authentication via X-User-Token header or Bearer token and is accessed via each tenant's custom subdomain.
version: 1.0.0
contact:
name: Tines API Documentation
url: https://www.tines.com/api/welcome/
x-api-id: tines-rest-api
x-provider-name: tines
servers:
- url: https://{tenantDomain}/api/v1
description: Tines tenant API v1
variables:
tenantDomain:
default: your-tenant.tines.com
description: Your Tines tenant domain (e.g. adjective-noun-1234.tines.com)
- url: https://{tenantDomain}/api/v2
description: Tines tenant API v2 (Cases)
variables:
tenantDomain:
default: your-tenant.tines.com
description: Your Tines tenant domain
security:
- BearerAuth: []
- ApiKeyAuth: []
tags:
- name: Tags
description: Manage tags for organizing resources
paths:
/tags:
get:
operationId: listTags
summary: List tags
description: Returns a list of tags accessible by the API key.
tags:
- Tags
parameters:
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PerPage'
responses:
'200':
description: Paginated list of tags
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PaginatedMeta'
- type: object
properties:
tags:
type: array
items:
$ref: '#/components/schemas/Tag'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
post:
operationId: createTag
summary: Create a tag
description: Creates a new tag for organizing resources.
tags:
- Tags
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TagCreate'
example:
name: priority-high
team_id: 1
color: red
responses:
'200':
description: Tag created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/Tag'
example:
id: 17
name: priority-high
color: '#FF8888'
teams:
- id: 276
name: Test team 1
created_at: '2026-04-10T09:15:42.128Z'
updated_at: '2026-04-10T09:15:42.128Z'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
/tags/{id}:
get:
operationId: getTag
summary: Get a tag
description: Returns details for a specific tag by ID.
tags:
- Tags
parameters:
- $ref: '#/components/parameters/ResourceId'
responses:
'200':
description: Tag details
content:
application/json:
schema:
$ref: '#/components/schemas/Tag'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
put:
operationId: updateTag
summary: Update a tag
description: Updates an existing tag by ID.
tags:
- Tags
parameters:
- $ref: '#/components/parameters/ResourceId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TagCreate'
responses:
'200':
description: Tag updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/Tag'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
delete:
operationId: deleteTag
summary: Delete a tag
description: Deletes a tag by ID.
tags:
- Tags
parameters:
- $ref: '#/components/parameters/ResourceId'
responses:
'200':
description: Tag deleted successfully
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
components:
schemas:
Error:
type: object
properties:
error:
type: string
description: Error message describing the issue
TagCreate:
type: object
required:
- name
- team_id
- color
properties:
name:
type: string
description: Tag name
team_id:
type: integer
description: ID of the team to which the tag belongs
color:
type: string
description: 'Tag color - one of purple, blue, gold, green, magenta, red, orange, mint, or a hex format like #RRGGBB'
Tag:
type: object
properties:
id:
type: integer
description: Unique tag identifier
name:
type: string
description: Tag name
color:
type: string
description: Tag color in hex format (e.g.
teams:
type: array
items:
type: object
properties:
id:
type: integer
name:
type: string
description: Teams this tag belongs to
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
PaginatedMeta:
type: object
properties:
meta:
type: object
properties:
current_page:
type: integer
previous_page:
type: integer
nullable: true
next_page:
type: integer
nullable: true
next_page_number:
type: integer
nullable: true
per_page:
type: integer
pages:
type: integer
count:
type: integer
responses:
Unauthorized:
description: Authentication credentials missing or invalid
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
NotFound:
description: The requested resource was not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
UnprocessableEntity:
description: Validation error — one or more request parameters are invalid
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
parameters:
ResourceId:
name: id
in: path
required: true
description: The unique numeric identifier of the resource
schema:
type: integer
PerPage:
name: per_page
in: query
description: Number of results per page (default 20, max 500)
schema:
type: integer
default: 20
maximum: 500
Page:
name: page
in: query
description: Page number for pagination (default 1)
schema:
type: integer
default: 1
securitySchemes:
BearerAuth:
type: http
scheme: bearer
description: 'Bearer token authentication using an Tines API key. Format: `Authorization: Bearer <api_key>`'
ApiKeyAuth:
type: apiKey
in: header
name: X-User-Token
description: 'API key authentication using the X-User-Token header. Format: `X-User-Token: <api_key>`'