Get Ticket

curl --request GET \
  --url https://api.stackone.com/unified/ticketing/tickets/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'

{
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "unified_custom_fields": {
      "my_project_custom_field_1": "REF-1236",
      "my_project_custom_field_2": "some other value"
    },
    "title": "System outage in production environment",
    "creator_id": "user-001",
    "reporters": [
      "user-001",
      "user-002"
    ],
    "assignees": [
      "user-001",
      "user-002"
    ],
    "content": [
      {
        "plain": "This is some content",
        "html": "<p>This is some content</p>"
      }
    ],
    "parent_id": "ticket-002",
    "priority": {
      "id": "001",
      "value": "medium",
      "source_value": "Normal"
    },
    "tags": [
      "tag-001",
      "tag-002"
    ],
    "projects": [
      {
        "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "name": "Project Falcon",
        "description": "Description of the project",
        "organization_id": "organization-001",
        "created_at": "2021-01-01T01:01:01.000Z",
        "updated_at": "2021-01-01T01:01:01.000Z"
      }
    ],
    "ticket_number": "ticket-001",
    "type": {
      "id": "001",
      "name": "Task",
      "project_id": "project-001"
    },
    "closed_at": "2021-01-01T01:01:01.000Z",
    "ticket_url": "https://help.company.com/tickets/SUP-5689",
    "status": {
      "id": "001",
      "type": {
        "value": "to-do",
        "source_value": "New"
      },
      "name": "Backlog"
    },
    "organization": {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "domain": "company.com",
      "name": "Company"
    },
    "components": [
      {
        "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "organization_id": "organization-001",
        "project_id": "project-001",
        "name": "Component Falcon",
        "description": "Description of the component",
        "created_at": "2021-01-01T01:01:01.000Z",
        "updated_at": "2021-01-01T01:01:01.000Z"
      }
    ],
    "created_at": "2021-01-01T01:01:01.000Z",
    "updated_at": "2021-01-01T01:01:01.000Z"
  },
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": {},
      "response": {}
    }
  ]
}

GET

unified

ticketing

tickets

{id}

Get Ticket

curl --request GET \
  --url https://api.stackone.com/unified/ticketing/tickets/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'

{
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "unified_custom_fields": {
      "my_project_custom_field_1": "REF-1236",
      "my_project_custom_field_2": "some other value"
    },
    "title": "System outage in production environment",
    "creator_id": "user-001",
    "reporters": [
      "user-001",
      "user-002"
    ],
    "assignees": [
      "user-001",
      "user-002"
    ],
    "content": [
      {
        "plain": "This is some content",
        "html": "<p>This is some content</p>"
      }
    ],
    "parent_id": "ticket-002",
    "priority": {
      "id": "001",
      "value": "medium",
      "source_value": "Normal"
    },
    "tags": [
      "tag-001",
      "tag-002"
    ],
    "projects": [
      {
        "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "name": "Project Falcon",
        "description": "Description of the project",
        "organization_id": "organization-001",
        "created_at": "2021-01-01T01:01:01.000Z",
        "updated_at": "2021-01-01T01:01:01.000Z"
      }
    ],
    "ticket_number": "ticket-001",
    "type": {
      "id": "001",
      "name": "Task",
      "project_id": "project-001"
    },
    "closed_at": "2021-01-01T01:01:01.000Z",
    "ticket_url": "https://help.company.com/tickets/SUP-5689",
    "status": {
      "id": "001",
      "type": {
        "value": "to-do",
        "source_value": "New"
      },
      "name": "Backlog"
    },
    "organization": {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "domain": "company.com",
      "name": "Company"
    },
    "components": [
      {
        "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "organization_id": "organization-001",
        "project_id": "project-001",
        "name": "Component Falcon",
        "description": "Description of the component",
        "created_at": "2021-01-01T01:01:01.000Z",
        "updated_at": "2021-01-01T01:01:01.000Z"
      }
    ],
    "created_at": "2021-01-01T01:01:01.000Z",
    "updated_at": "2021-01-01T01:01:01.000Z"
  },
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": {},
      "response": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

x-account-id

string

required

The account identifier

Path Parameters

string

required

Query Parameters

raw

boolean | null

Indicates that the raw request result should be returned in addition to the mapped result (default value is false)

proxy

object

Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key

fields

string | null

The comma separated list of fields that will be returned in the response (if empty, all fields are returned)

Example:

"id,remote_id,type,ticket_number,title,creator_id,remote_creator_id,reporters,assignees,content,parent_id,remote_parent_id,closed_at,ticket_url,status,priority,tags,projects,components,organization,created_at,updated_at,unified_custom_fields"

Response

The ticket with the given identifier was retrieved.

data

object

Show child attributes

data.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.unified_custom_fields

object

Custom Unified Fields configured in your StackOne project

Example:

{
  "my_project_custom_field_1": "REF-1236",
  "my_project_custom_field_2": "some other value"
}

data.title

string | null

The title or subject of the ticket

Example:

"System outage in production environment"

data.creator_id

string | null

The creator of the ticket

Example:

"user-001"

data.reporters

string[] | null

Users who reported the ticket

Example:

["user-001", "user-002"]

data.assignees

string[] | null

Agents assigned to the ticket

Example:

["user-001", "user-002"]

data.content

object[] | null

Array of content associated with the ticket

Show child attributes

data.content.plain

string | null

The content of the ticket

Example:

"This is some content"

data.content.html

string | null

The HTML content of the ticket

Example:

"<p>This is some content</p>"

data.parent_id

string | null

ID of the parent ticket if this is a sub-ticket

Example:

"ticket-002"

data.priority

object

Priority of the ticket

Show child attributes

data.priority.id

string | null

The id of the ticket priority.

Example:

"001"

data.priority.value

enum<string> | null

The priority of the ticket.

Available options:

lowest,

low,

medium,

high,

highest,

unmapped_value,

Example:

"medium"

data.priority.source_value

The source value of the ticket priority.

Example:

"Normal"

data.tags

string[] | null

The tags of the ticket

Example:

["tag-001", "tag-002"]

data.projects

object[] | null

Projects the ticket belongs to

Show child attributes

data.projects.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.projects.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.projects.name

string | null

The name of the project

Example:

"Project Falcon"

data.projects.description

string | null

The description of the project

Example:

"Description of the project"

data.projects.organization_id

string | null

The organization id related to the project

Example:

"organization-001"

data.projects.created_at

string<date-time> | null

The timestamp when the record was created

Example:

"2021-01-01T01:01:01.000Z"

data.projects.updated_at

string<date-time> | null

The timestamp when the record was last updated

Example:

"2021-01-01T01:01:01.000Z"

data.ticket_number

string | null

The unique ticket number or reference ID

Example:

"ticket-001"

data.type

object

The type of the ticket

Show child attributes

data.type.id

string | null

The id of the ticket type.

Example:

"001"

data.type.name

string | null

The name of the ticket type.

Example:

"Task"

data.type.project_id

string | null

The project the ticket type belongs to.

Example:

"project-001"

data.closed_at

string<date-time> | null

The date the ticket was closed

Example:

"2021-01-01T01:01:01.000Z"

data.ticket_url

string | null

URL to view the ticket in the source system

Example:

"https://help.company.com/tickets/SUP-5689"

data.status

object

Current status of the ticket

Show child attributes

data.status.id

string | null

The id of the ticket status.

Example:

"001"

data.status.type

object

The type of this status

Show child attributes

data.status.type.value

enum<string> | null

The type of this status

Available options:

to-do,

in-progress,

closed,

unmapped_value,

Example:

"to-do"

data.status.type.source_value

The source value of this status type

Example:

"New"

data.status.name

string | null

The name of the ticket status.

Example:

"Backlog"

data.organization

object

Organization associated with the ticket

Show child attributes

data.organization.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.organization.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.organization.domain

string | null

The domain of the organization

Example:

"company.com"

data.organization.name

string | null

The name of the organization

Example:

"Company"

data.components

object[] | null

Components associated with the ticket

Show child attributes

data.components.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.components.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.components.organization_id

string | null

The organization id related to the component

Example:

"organization-001"

data.components.project_id

string | null

The project id related to the component

Example:

"project-001"

data.components.name

string | null

The name of the component

Example:

"Component Falcon"

data.components.description

string | null

The description of the component

Example:

"Description of the component"

data.components.created_at

string<date-time> | null

The timestamp when the record was created

Example:

"2021-01-01T01:01:01.000Z"

data.components.updated_at

string<date-time> | null

The timestamp when the record was last updated

Example:

"2021-01-01T01:01:01.000Z"

data.created_at

string<date-time> | null

The timestamp when the record was created

Example:

"2021-01-01T01:01:01.000Z"

data.updated_at

string<date-time> | null

The timestamp when the record was last updated

Example:

"2021-01-01T01:01:01.000Z"

raw

object[] | null

Show child attributes

raw.method

string

required

raw.url

string

required

raw.body

object

raw.response

Create Ticket Update Ticket

⌘I

Getting Started

API Reference

Get Ticket

Authorizations

Headers

Path Parameters

Query Parameters

Response