Get Many

curl --request GET \
  --url https://api.onfragment.com/api/v1/tasks \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "archived": true,
      "status": "TODO",
      "legacy_data": {},
      "skills": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "assignee_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "participants": {},
      "case_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "parent_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "due_at": "2023-11-07T05:31:56Z",
      "snooze_expires_at": "2023-11-07T05:31:56Z",
      "fields": {},
      "metadata_form_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "form_data": {},
      "form_type": "<string>",
      "assigned_at": "2023-11-07T05:31:56Z",
      "started_at": "2023-11-07T05:31:56Z",
      "done_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "assignee_updated_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "queue_updated_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "is_assigned_player": true,
      "internal_created_at": "2023-11-07T05:31:56Z",
      "internal_updated_at": "2023-11-07T05:31:56Z",
      "external_created_at": "2023-11-07T05:31:56Z",
      "external_updated_at": "2023-11-07T05:31:56Z",
      "external_status": "TODO",
      "external_status_updated_at": "2023-11-07T05:31:56Z",
      "external_assignee_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "queue_time": 123,
      "queue_time_business": 123,
      "work_time": 123,
      "work_time_business": 123,
      "incremental_work_time": 123,
      "incremental_work_time_business": 123,
      "resolution_time": 123,
      "resolution_time_business": 123,
      "num_children": 123,
      "num_children_done": 123,
      "queue_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sla_breach_at": "2023-11-07T05:31:56Z",
      "sla_breach_business_at": "2023-11-07T05:31:56Z",
      "wait_time": 123,
      "wait_time_business": 123,
      "review_status": "<string>",
      "task_type": "<string>",
      "played_at": "2023-11-07T05:31:56Z",
      "assignee": {
        "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "archived": true,
        "role": "super_admin",
        "email": "[email protected]",
        "first_name": "<string>",
        "last_name": "<string>",
        "skills": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ],
        "legacy_data": {},
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "is_registered": true
      },
      "parent": "<unknown>",
      "children": [
        "<unknown>"
      ],
      "comments": [
        {
          "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "archived": true,
          "task_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "author_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "text": "<string>",
          "blocks": [
            {
              "id": "<string>",
              "type": "<string>",
              "props": {},
              "content": [
                {
                  "type": "<string>",
                  "text": "<string>",
                  "href": "<string>",
                  "content": "<array>",
                  "styles": {},
                  "props": {}
                }
              ],
              "children": "<array>"
            }
          ],
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "task": "<unknown>",
          "author": {
            "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "archived": true,
            "role": "super_admin",
            "email": "[email protected]",
            "first_name": "<string>",
            "last_name": "<string>",
            "skills": [
              "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            ],
            "legacy_data": {},
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "is_registered": true
          }
        }
      ]
    }
  ],
  "meta": {
    "limit": 123,
    "self_cursor": "<string>",
    "prev_cursor": "<string>",
    "next_cursor": "<string>",
    "total_count": 123
  }
}

Tasks

Get Many

Get many tasks.

You can filter on custom fields as well. For example

/tasks?my_custom_field=some_value

If you need more advanced filtering, use the /query endpoint.

NOTE: when performing full text search, the pagination is applied to the result of the full text search. The full text search itself is limited to 10x the limit.

GET

api

tasks

Get Many

curl --request GET \
  --url https://api.onfragment.com/api/v1/tasks \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "archived": true,
      "status": "TODO",
      "legacy_data": {},
      "skills": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "assignee_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "participants": {},
      "case_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "parent_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "due_at": "2023-11-07T05:31:56Z",
      "snooze_expires_at": "2023-11-07T05:31:56Z",
      "fields": {},
      "metadata_form_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "form_data": {},
      "form_type": "<string>",
      "assigned_at": "2023-11-07T05:31:56Z",
      "started_at": "2023-11-07T05:31:56Z",
      "done_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "assignee_updated_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "queue_updated_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "is_assigned_player": true,
      "internal_created_at": "2023-11-07T05:31:56Z",
      "internal_updated_at": "2023-11-07T05:31:56Z",
      "external_created_at": "2023-11-07T05:31:56Z",
      "external_updated_at": "2023-11-07T05:31:56Z",
      "external_status": "TODO",
      "external_status_updated_at": "2023-11-07T05:31:56Z",
      "external_assignee_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "queue_time": 123,
      "queue_time_business": 123,
      "work_time": 123,
      "work_time_business": 123,
      "incremental_work_time": 123,
      "incremental_work_time_business": 123,
      "resolution_time": 123,
      "resolution_time_business": 123,
      "num_children": 123,
      "num_children_done": 123,
      "queue_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sla_breach_at": "2023-11-07T05:31:56Z",
      "sla_breach_business_at": "2023-11-07T05:31:56Z",
      "wait_time": 123,
      "wait_time_business": 123,
      "review_status": "<string>",
      "task_type": "<string>",
      "played_at": "2023-11-07T05:31:56Z",
      "assignee": {
        "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "archived": true,
        "role": "super_admin",
        "email": "[email protected]",
        "first_name": "<string>",
        "last_name": "<string>",
        "skills": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ],
        "legacy_data": {},
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "is_registered": true
      },
      "parent": "<unknown>",
      "children": [
        "<unknown>"
      ],
      "comments": [
        {
          "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "archived": true,
          "task_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "author_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "text": "<string>",
          "blocks": [
            {
              "id": "<string>",
              "type": "<string>",
              "props": {},
              "content": [
                {
                  "type": "<string>",
                  "text": "<string>",
                  "href": "<string>",
                  "content": "<array>",
                  "styles": {},
                  "props": {}
                }
              ],
              "children": "<array>"
            }
          ],
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "task": "<unknown>",
          "author": {
            "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "archived": true,
            "role": "super_admin",
            "email": "[email protected]",
            "first_name": "<string>",
            "last_name": "<string>",
            "skills": [
              "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            ],
            "legacy_data": {},
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "is_registered": true
          }
        }
      ]
    }
  ],
  "meta": {
    "limit": 123,
    "self_cursor": "<string>",
    "prev_cursor": "<string>",
    "next_cursor": "<string>",
    "total_count": 123
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

fragment-user-agent

string | null

fragment-account

string | null

fragment-versioning

string | null

fragment-user

string<uuid> | null

Query Parameters

archived

boolean

default:false

uids

status

Task Status Enum.

Available options:

TODO,

STARTED,

DONE

external_status

Task Status Enum.

Available options:

TODO,

STARTED,

DONE

queue_uid

assignee_uid

external_assignee_uid

case_uid

task_type

default:task

Available options:

task,

review

parent_uid

metadata_form_uid

form_type

query

created_at_after

created_at_before

updated_at_after

updated_at_before

order_by

enum<string>

default:created_at

Available options:

created_at,

updated_at

expand

enum<string>[] | null

Available options:

comments,

children,

parent,

assignee

limit

integer

default:100

cursor

string | null

Response

Successful Response

items

Task · object[]

required

Show child attributes

items.uid

string<uuid>

required

items.archived

boolean

required

items.status

enum<string>

required

Task Status Enum.

Available options:

TODO,

STARTED,

DONE

items.legacy_data

Legacy Data · object

required

items.skills

string<uuid>[]

required

items.assignee_uid

string<uuid> | null

required

items.participants

Participants · object

required

Show child attributes

items.participants.{key}

ParticipantInfo · object

Participant information.

Show child attributes

items.participants.{key}.subscribed

boolean

required

items.case_uid

string<uuid> | null

required

items.parent_uid

string<uuid> | null

required

items.due_at

string<date-time>

required

items.snooze_expires_at

string<date-time> | null

required

items.fields

Fields · object

required

items.metadata_form_uid

string<uuid> | null

required

items.form_data

Form Data · object

required

items.form_type

string | null

required

items.assigned_at

string<date-time> | null

required

items.started_at

string<date-time> | null

required

items.done_at

string<date-time> | null

required

items.created_at

string<date-time>

required

items.updated_at

string<date-time>

required

items.assignee_updated_by

string<uuid> | null

required

items.queue_updated_by

string<uuid> | null

required

items.is_assigned_player

boolean | null

required

items.internal_created_at

string<date-time> | null

required

items.internal_updated_at

string<date-time> | null

required

items.external_created_at

string<date-time> | null

required

items.external_updated_at

string<date-time> | null

required

items.external_status

enum<string> | null

required

Task Status Enum.

Available options:

TODO,

STARTED,

DONE

items.external_status_updated_at

string<date-time> | null

required

items.external_assignee_uid

string<uuid> | null

required

items.queue_time

integer | null

required

items.queue_time_business

integer | null

required

items.work_time

integer | null

required

items.work_time_business

integer | null

required

items.incremental_work_time

integer | null

required

items.incremental_work_time_business

integer | null

required

items.resolution_time

integer | null

required

items.resolution_time_business

integer | null

required

items.num_children

integer

required

items.num_children_done

integer

required

items.queue_uid

string<uuid> | null

items.sla_breach_at

string<date-time> | null

items.sla_breach_business_at

string<date-time> | null

items.wait_time

integer | null

items.wait_time_business

integer | null

items.review_status

string | null

items.task_type

string | null

items.played_at

string<date-time> | null

items.assignee

User · object

User Schema.

Show child attributes

items.assignee.uid

string<uuid>

required

items.assignee.archived

boolean

required

items.assignee.role

enum<string>

required

User Role Enum.

Available options:

super_admin,

admin,

member

items.assignee.email

string<email>

required

items.assignee.first_name

string

required

items.assignee.last_name

string

required

items.assignee.skills

string<uuid>[]

required

items.assignee.legacy_data

Legacy Data · object

required

items.assignee.created_at

string<date-time>

required

items.assignee.updated_at

string<date-time>

required

items.assignee.is_registered

boolean | null

items.parent

unknown

items.children

any[] | null

items.comments

TaskComment · object[] | null

Show child attributes

items.comments.uid

string<uuid>

required

items.comments.archived

boolean

required

items.comments.task_uid

string<uuid>

required

items.comments.author_uid

string<uuid> | null

required

items.comments.text

string

required

items.comments.blocks

TextBlock · object[]

required

Show child attributes

items.comments.blocks.id

string

required

items.comments.blocks.type

string

required

items.comments.blocks.props

Props · object

items.comments.blocks.content

TextBlockContent · object[]

Show child attributes

items.comments.blocks.content.type

string

required

items.comments.blocks.content.text

string | null

items.comments.blocks.content.href

string | null

items.comments.blocks.content.content

Content · array

items.comments.blocks.content.styles

Styles · object

items.comments.blocks.content.props

Props · object

items.comments.blocks.children

Children · array

items.comments.created_at

string<date-time>

required

items.comments.updated_at

string<date-time>

required

items.comments.task

unknown

items.comments.author

User · object

User Schema.

Show child attributes

items.comments.author.uid

string<uuid>

required

items.comments.author.archived

boolean

required

items.comments.author.role

enum<string>

required

User Role Enum.

Available options:

super_admin,

admin,

member

items.comments.author.email

string<email>

required

items.comments.author.first_name

string

required

items.comments.author.last_name

string

required

items.comments.author.skills

string<uuid>[]

required

items.comments.author.legacy_data

Legacy Data · object

required

items.comments.author.created_at

string<date-time>

required

items.comments.author.updated_at

string<date-time>

required

items.comments.author.is_registered

boolean | null

Introduction

Guides

Objects

Endpoints

Get Many

Authorizations

Headers

Query Parameters

Response