Skip to content
SuiteOp Help Center
Dashboard

Get a single task template by ID.

GET
/task-templates/{id}
 
curl --request GET \
  --url https://api-us.suiteop.com/api/v1/task-templates/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Get a single template’s full structure: name, description, departmentId, estimated time + cost, and the nested groups + checklist items operators will see when the task is materialized. Use when the user asks ‘what does the Turnover Clean template include?’ or before creating a task to preview the requirements that will be copied onto it.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string format: uuid
/^([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

Section titled “ Responses ”

200

Section titled “200 ”

Success.

Media type application/json
object
data
required

Response payload.

object
createdAt
required
string format: date-time
createdById
required
Any of:
string
deletedAt
required
Any of:
string format: date-time
departmentId
required
string
description
required
Any of:
string
descriptionText
required
Any of:
string
estCost
required
Any of:
number
estTime
required
Any of:
number
groups
required
Array<object>
object
checklistItems
required
Array<object>
object
createdAt
required
string format: date-time
createdById
required
Any of:
string
descriptionText
required
Any of:
string
groupId
required
Any of:
string
id
required
string
optionGroupId
required
Any of:
string
rank
required
Any of:
number
templateId
required
Any of:
string
updatedAt
required
string format: date-time
userCreated
required
Any of:
boolean
createdAt
required
string format: date-time
createdById
required
Any of:
string
id
required
string
isArchived
required
boolean
optionSetId
required
Any of:
string
parentCategoryId
required
Any of:
string
photoAiVerificationPromptText
required
Any of:
string
photoRequired
required
Any of:
boolean
photoRequirement
required
Any of:
string
rank
required
Any of:
number
reference
required
Any of:
string
targetCategoryId
required
Any of:
string
targetLevel
required
Any of:
string
templateId
required
Any of:
string
titleText
required
Any of:
string
type
required
Any of:
string
updatedAt
required
string format: date-time
userCreated
required
Any of:
boolean
id
required
string
isAdminTemplate
required
Any of:
boolean
name
required
string
nameText
required
Any of:
string
permissionToEnter
required
Any of:
boolean
priority
required
Any of:
string
requiredSkillId
required
Any of:
string
translationCoverage
required
object
key
additional properties
number
translationFieldCount
required
number
updatedAt
required
string format: date-time
meta
required

Response metadata present on every success response.

object
pagination

Present on list responses.

object
limit
required

Page size used for this request.

integer
offset
required

Number of items skipped.

integer
total
required

Total number of matching items (across all pages).

integer
requestId
required

Unique identifier for this request.

string
Example generated
{
  "data": {
    "createdAt": "2026-04-15T12:00:00Z",
    "createdById": "example",
    "deletedAt": "2026-04-15T12:00:00Z",
    "departmentId": "example",
    "description": "example",
    "descriptionText": "example",
    "estCost": 1,
    "estTime": 1,
    "groups": [
      {
        "checklistItems": [
          {
            "createdAt": "2026-04-15T12:00:00Z",
            "createdById": "example",
            "descriptionText": "example",
            "groupId": "example",
            "id": "example",
            "optionGroupId": "example",
            "rank": 1,
            "templateId": "example",
            "updatedAt": "2026-04-15T12:00:00Z",
            "userCreated": true
          }
        ],
        "createdAt": "2026-04-15T12:00:00Z",
        "createdById": "example",
        "id": "example",
        "isArchived": true,
        "optionSetId": "example",
        "parentCategoryId": "example",
        "photoAiVerificationPromptText": "example",
        "photoRequired": true,
        "photoRequirement": "example",
        "rank": 1,
        "reference": "example",
        "targetCategoryId": "example",
        "targetLevel": "example",
        "templateId": "example",
        "titleText": "example",
        "type": "example",
        "updatedAt": "2026-04-15T12:00:00Z",
        "userCreated": true
      }
    ],
    "id": "example",
    "isAdminTemplate": true,
    "name": "example",
    "nameText": "example",
    "permissionToEnter": true,
    "priority": "example",
    "requiredSkillId": "example",
    "translationCoverage": {
      "additionalProperty": 1
    },
    "translationFieldCount": 1,
    "updatedAt": "2026-04-15T12:00:00Z"
  },
  "meta": {
    "pagination": {
      "limit": 1,
      "offset": 1,
      "total": 1
    },
    "requestId": "example"
  }
}

Headers

Section titled “Headers ”
X-RateLimit-Limit
integer

Maximum requests per minute for this API key.

X-RateLimit-Remaining
integer

Remaining requests in the current rate-limit window.

X-RateLimit-Reset
integer

Unix epoch seconds when the rate-limit window resets.

X-Request-Id
string

Unique identifier for this request (matches meta.requestId in the body).

400

Section titled “400 ”

400

Media type application/json
ValidationError

Error envelope returned for HTTP 400 responses.

object
error
required
object
code
required

Machine-readable error code.

string
details

Optional structured details (omitted when undefined).

object
key
additional properties
any
message
required

Human-readable error message.

string
type
required

Error type.

string
Allowed values: validation_error
meta
required
object
requestId
required
string
Example 
{
  "error": {
    "type": "validation_error"
  }
}

Headers

Section titled “Headers ”
X-RateLimit-Limit
integer

Maximum requests per minute.

X-RateLimit-Remaining
integer

Remaining requests in the current window.

X-RateLimit-Reset
integer

Unix epoch seconds when the window resets.

X-Request-Id
string

Request correlation id (also in meta.requestId).

401

Section titled “401 ”

401

Media type application/json
AuthenticationError

Error envelope returned for HTTP 401 responses.

object
error
required
object
code
required

Machine-readable error code.

string
details

Optional structured details (omitted when undefined).

object
key
additional properties
any
message
required

Human-readable error message.

string
type
required

Error type.

string
Allowed values: authentication_error
meta
required
object
requestId
required
string
Example 
{
  "error": {
    "type": "authentication_error"
  }
}

Headers

Section titled “Headers ”
X-Request-Id
string

Request correlation id (also in meta.requestId).

403

Section titled “403 ”

403

Media type application/json
AuthorizationError

Error envelope returned for HTTP 403 responses.

object
error
required
object
code
required

Machine-readable error code.

string
details

Optional structured details (omitted when undefined).

object
key
additional properties
any
message
required

Human-readable error message.

string
type
required

Error type.

string
Allowed values: authorization_error
meta
required
object
requestId
required
string
Example 
{
  "error": {
    "type": "authorization_error"
  }
}

Headers

Section titled “Headers ”
X-RateLimit-Limit
integer

Maximum requests per minute.

X-RateLimit-Remaining
integer

Remaining requests in the current window.

X-RateLimit-Reset
integer

Unix epoch seconds when the window resets.

X-Request-Id
string

Request correlation id (also in meta.requestId).

404

Section titled “404 ”

404

Media type application/json
NotFoundError

Error envelope returned for HTTP 404 responses.

object
error
required
object
code
required

Machine-readable error code.

string
details

Optional structured details (omitted when undefined).

object
key
additional properties
any
message
required

Human-readable error message.

string
type
required

Error type.

string
Allowed values: not_found_error
meta
required
object
requestId
required
string
Example 
{
  "error": {
    "type": "not_found_error"
  }
}

Headers

Section titled “Headers ”
X-RateLimit-Limit
integer

Maximum requests per minute.

X-RateLimit-Remaining
integer

Remaining requests in the current window.

X-RateLimit-Reset
integer

Unix epoch seconds when the window resets.

X-Request-Id
string

Request correlation id (also in meta.requestId).

409

Section titled “409 ”

409

Media type application/json
ConflictError

Error envelope returned for HTTP 409 responses.

object
error
required
object
code
required

Machine-readable error code.

string
details

Optional structured details (omitted when undefined).

object
key
additional properties
any
message
required

Human-readable error message.

string
type
required

Error type.

string
Allowed values: conflict_error
meta
required
object
requestId
required
string
Example 
{
  "error": {
    "type": "conflict_error"
  }
}

Headers

Section titled “Headers ”
X-RateLimit-Limit
integer

Maximum requests per minute.

X-RateLimit-Remaining
integer

Remaining requests in the current window.

X-RateLimit-Reset
integer

Unix epoch seconds when the window resets.

X-Request-Id
string

Request correlation id (also in meta.requestId).

422

Section titled “422 ”

422

Media type application/json
BusinessRuleError

Error envelope returned for HTTP 422 responses.

object
error
required
object
code
required

Machine-readable error code.

string
details

Optional structured details (omitted when undefined).

object
key
additional properties
any
message
required

Human-readable error message.

string
type
required

Error type.

string
Allowed values: business_rule_error
meta
required
object
requestId
required
string
Example 
{
  "error": {
    "type": "business_rule_error"
  }
}

Headers

Section titled “Headers ”
X-RateLimit-Limit
integer

Maximum requests per minute.

X-RateLimit-Remaining
integer

Remaining requests in the current window.

X-RateLimit-Reset
integer

Unix epoch seconds when the window resets.

X-Request-Id
string

Request correlation id (also in meta.requestId).

429

Section titled “429 ”

429

Media type application/json
RateLimitError

Error envelope returned for HTTP 429 responses.

object
error
required
object
code
required

Machine-readable error code.

string
details

Optional structured details (omitted when undefined).

object
key
additional properties
any
message
required

Human-readable error message.

string
type
required

Error type.

string
Allowed values: rate_limit_error
meta
required
object
requestId
required
string
Example 
{
  "error": {
    "type": "rate_limit_error"
  }
}

Headers

Section titled “Headers ”
Retry-After
integer

Number of seconds to wait before retrying.

X-RateLimit-Limit
integer

Maximum requests per minute.

X-RateLimit-Remaining
integer

Remaining requests in the current window.

X-RateLimit-Reset
integer

Unix epoch seconds when the window resets.

X-Request-Id
string

Request correlation id (also in meta.requestId).

500

Section titled “500 ”

500

Media type application/json
InternalError

Error envelope returned for HTTP 500 responses.

object
error
required
object
code
required

Machine-readable error code.

string
details

Optional structured details (omitted when undefined).

object
key
additional properties
any
message
required

Human-readable error message.

string
type
required

Error type.

string
Allowed values: internal_error
meta
required
object
requestId
required
string
Example 
{
  "error": {
    "type": "internal_error"
  }
}

Headers

Section titled “Headers ”
X-RateLimit-Limit
integer

Maximum requests per minute.

X-RateLimit-Remaining
integer

Remaining requests in the current window.

X-RateLimit-Reset
integer

Unix epoch seconds when the window resets.

X-Request-Id
string

Request correlation id (also in meta.requestId).

© 2026 SuiteOp Inc. All rights reserved.
Website Dashboard Status Contact Support