GET
/
v1
/
requests
/
{uid}
Retrieve a Request
curl --request GET \
  --url https://api.siit.io/v1/requests/{uid} \
  --header 'Authorization: Bearer <token>'
{
  "uid": "<string>",
  "title": "<string>",
  "description": "<string>",
  "priority": "low",
  "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>",
  "slack_direct_link": "<string>",
  "completed_at": "2023-11-07T05:31:56Z",
  "completed_by_uid": "<string>",
  "tag_uids": [
    "<string>"
  ],
  "follower_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"
  },
  "archived_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z"
}

Usage

Authorizations

Authorization
string
header
required

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

Path Parameters

uid
string
required

The UID of the request

Response

Request show

uid
string

The UID of the Request

title
string

The title of the Request

description
string | null

The description of the Request

priority
enum<string>
Available options:
low,
medium,
high,
urgent
submitted_from
enum<string>

Describes how the request was submitted

Available options:
employee_portal,
slack,
mail,
ms_teams,
admin_dashboard,
workflow,
public_api,
external
author_uid
string | null

The UID of the author

requested_by_uid
string | null

The UID of the requester

assignee_admin_uid
string | null

The UID of assigned User

assignee_inbox_uid
string | null

The UID of assigned Team inbox

target_uid
string | null

The UID of the associated Service/Application

The link to the request in Siit admin dashboard

mode
enum<string>

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

Available options:
private,
public
status
enum<string>
default:open

Request status

Available options:
open,
in_progress,
waiting,
resolved,
archived
friendly_id
string

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

slack_channel_id
string | null

ID of the channel where the request was created

slack_thread_ts
string | null

Slack thread timestamp

slack_ts
string | null

Slack timestamp

Slack message permalink

completed_at
string<date-time> | null

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

completed_by_uid
string | null

The UID of the user that completed this request

tag_uids
string[] | null

Array containing the Request tags UIDs

follower_uids
string[] | null

Array containing the followers UIDs

custom_form_inputs
object[] | null

Custom forms attached to this request

sla_data
object | null

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

archived_at
string<date-time> | null

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

updated_at
string<date-time>

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

created_at
string<date-time>

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