List all Requests

GET

requests

curl --request GET \
  --url https://api.siit.io/v1/requests \
  --header 'Authorization: Bearer <token>'

{
  "meta": {
    "count": 123,
    "total": 123,
    "current_page": 123,
    "per_page": 20,
    "next_page_link": "<string>",
    "previous_page_link": "<string>"
  },
  "results": [
    {
      "uid": "<string>",
      "title": "<string>",
      "description": "<string>",
      "submitted_from": "employee_portal",
      "author_uid": "<string>",
      "requested_by_uid": "<string>",
      "assignee_admin_uid": "<string>",
      "assignee_inbox_uid": "<string>",
      "target_uid": "<string>",
      "admin_permalink_url": "<string>",
      "mode": "private",
      "status": "open",
      "friendly_id": "<string>",
      "slack_channel_id": "<string>",
      "slack_thread_ts": "<string>",
      "slack_ts": "<string>",
      "completed_at": "2023-11-07T05:31:56Z",
      "completed_by_uid": "<string>",
      "tag_uids": [
        "<string>"
      ],
      "custom_form_inputs": [
        {
          "label": "<string>",
          "kind": "attachment",
          "value": "<string>"
        }
      ],
      "sla_data": {
        "first_replied_at": "2023-11-07T05:31:56Z",
        "first_completed_at": "2023-11-07T05:31:56Z"
      },
      "updated_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Query Parameters

status_in[]

enum<string>[]

Filter by Ticket status.

Available options:

open,

in_progress,

waiting,

resolved,

archived

target_uid_in[]

string[]

Filter by associated Service/App.

requested_by_uid_in[]

string[]

Filter by Requester.

assignee_admin_uid_in[]

string[]

Filter by Assigned User

assignee_inbox_uid_in[]

string[]

Filter by Assigned Team inbox

created_after

string

Filter Requests created after a DateTime (ISO 8601).

created_before

string

Filter Requests created before a DateTime (ISO 8601).

updated_after

string

Filter Requests updated after a DateTime (ISO 8601).

updated_before

string

Filter Requests updated before a DateTime (ISO 8601).

sorts

string

Sort Requests by field.

page

integer

The current page

per_page

integer

Number of results retrieved per page.

Response

200

application/json

successful

meta

object

results

object[]

results.uid

string

The UID of the Request.

results.title

string

The title of the Request

results.description

string | null

The description of the Request

results.submitted_from

enum<string>

Describes how the request was submitted.

Available options:

employee_portal,

slack,

mail,

ms_teams,

admin_dashboard,

workflow,

public_api,

external

results.author_uid

string | null

The UID of the author.

results.requested_by_uid

string | null

The UID of the requester.

results.assignee_admin_uid

string | null

The UID of assigned User

results.assignee_inbox_uid

string | null

The UID of assigned Team inbox

results.target_uid

string | null

The UID of the associated Service/Application.

results.admin_permalink_url

string

The link to the request in Siit admin dashboard.

results.mode

enum<string>

Will be "public" only for Slack public threads (for now).

Available options:

private,

public

results.status

enum<string>

default:open

Request status

Available options:

open,

in_progress,

waiting,

resolved,

archived

results.friendly_id

string

A friendly ID (REQ-xx) where xx is a sequential number

results.slack_channel_id

string | null

ID of the channel where the request was created.

results.slack_thread_ts

string | null

Slack thread timestamp.

results.slack_ts

string | null

Slack timestamp.

results.completed_at

string | null

datetime formatted as ISO 8601 (e.g. "2020-12-15T03:34:13.000Z")

results.completed_by_uid

string | null

The UID of the user that completed this request.

results.tag_uids

string[] | null

Array containing the Request tags UIDs.

results.custom_form_inputs

object[] | null

Custom forms attached to this request.

results.sla_data

object | null

A Hash containing SLA data (only sent when Company has access to the feature).

results.updated_at

string

datetime formatted as ISO 8601 (e.g. "2020-12-15T03:34:13.000Z")

results.created_at

string

datetime formatted as ISO 8601 (e.g. "2020-12-15T03:34:13.000Z")

Errors Create a Request

curl --request GET \
  --url https://api.siit.io/v1/requests \
  --header 'Authorization: Bearer <token>'

{
  "meta": {
    "count": 123,
    "total": 123,
    "current_page": 123,
    "per_page": 20,
    "next_page_link": "<string>",
    "previous_page_link": "<string>"
  },
  "results": [
    {
      "uid": "<string>",
      "title": "<string>",
      "description": "<string>",
      "submitted_from": "employee_portal",
      "author_uid": "<string>",
      "requested_by_uid": "<string>",
      "assignee_admin_uid": "<string>",
      "assignee_inbox_uid": "<string>",
      "target_uid": "<string>",
      "admin_permalink_url": "<string>",
      "mode": "private",
      "status": "open",
      "friendly_id": "<string>",
      "slack_channel_id": "<string>",
      "slack_thread_ts": "<string>",
      "slack_ts": "<string>",
      "completed_at": "2023-11-07T05:31:56Z",
      "completed_by_uid": "<string>",
      "tag_uids": [
        "<string>"
      ],
      "custom_form_inputs": [
        {
          "label": "<string>",
          "kind": "attachment",
          "value": "<string>"
        }
      ],
      "sla_data": {
        "first_replied_at": "2023-11-07T05:31:56Z",
        "first_completed_at": "2023-11-07T05:31:56Z"
      },
      "updated_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ]
}

API Documentation

Request

Comment

User

Application

Tag

Workflow

Service

Authorizations

Query Parameters

Response