Issues

Get a list of issues.

GEThttps://api.usepylon.com/issues

Query parameters

Response

Body

dataarray of Issue (object)

The data payload of the response.

errorsarray of string

The list of errors, if any.

paginationPagination (object)

request_idstring

The request ID for tracking.

Request

const response = await fetch('https://api.usepylon.com/issues?start_time=text&end_time=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "account": {
        "id": "text"
      },
      "assignee": {
        "id": "text"
      },
      "body_html": "text",
      "created_at": "text",
      "csat_responses": [
        {
          "comment": "text"
        }
      ],
      "external_issues": [
        {
          "external_id": "text",
          "link": "text",
          "source": "text"
        }
      ],
      "first_response_time": "text",
      "id": "text",
      "latest_message_time": "text",
      "link": "text",
      "requester": {
        "id": "text"
      },
      "resolution_time": "text",
      "slack": {
        "channel_id": "text",
        "message_ts": "text"
      },
      "source": "slack",
      "state": "text",
      "tags": [
        "text"
      ],
      "team": {
        "id": "text"
      },
      "title": "text",
      "type": "Conversation"
    }
  ],
  "errors": [
    "text"
  ],
  "pagination": {
    "cursor": "text",
    "has_next_page": false
  },
  "request_id": "text"
}

Create a new issue.

POSThttps://api.usepylon.com/issues

Body

account_idstring

The account that this issue belongs to.

assignee_idstring

The user the issue should be assigned to.

attachment_urlsarray of string

An array of attachment URLs to attach to this issue.

body_html*string

The HTML content of the body of the issue.

custom_fieldsarray of CustomFieldValue (object)

An array of custom fields to be used on this issue.

destination_metadataDestinationMetadata (object)

prioritystring

The priority of the issue. Can be one of urgent, high, medium, or low.

requester_avatar_urlstring

The URL of an avatar of the requester.

requester_emailstring

The email of the user that this issue is on behalf of.

requester_idstring

The requester that this issue is on behalf of.

requester_namestring

The full name of the user that this issue is on behalf of.

tagsarray of string

An array of strings to use as tags on this issue. If provided, the issue tags will be updated to the given tags.

team_idstring

The ID of the team this issue should be assigned to.

title*string

The title of the issue.

Response

Body

dataIssue (object)

errorsarray of string

The list of errors, if any.

paginationPagination (object)

request_idstring

The request ID for tracking.

Request

const response = await fetch('https://api.usepylon.com/issues', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "body_html": "text",
      "title": "text"
    }),
});
const data = await response.json();

Response

{
  "data": {
    "account": {
      "id": "text"
    },
    "assignee": {
      "id": "text"
    },
    "body_html": "text",
    "created_at": "text",
    "csat_responses": [
      {
        "comment": "text"
      }
    ],
    "external_issues": [
      {
        "external_id": "text",
        "link": "text",
        "source": "text"
      }
    ],
    "first_response_time": "text",
    "id": "text",
    "latest_message_time": "text",
    "link": "text",
    "requester": {
      "id": "text"
    },
    "resolution_time": "text",
    "slack": {
      "channel_id": "text",
      "message_ts": "text"
    },
    "source": "slack",
    "state": "text",
    "tags": [
      "text"
    ],
    "team": {
      "id": "text"
    },
    "title": "text",
    "type": "Conversation"
  },
  "errors": [
    "text"
  ],
  "pagination": {
    "cursor": "text",
    "has_next_page": false
  },
  "request_id": "text"
}

Get an issue by its ID.

GEThttps://api.usepylon.com/issues/{id}

Path parameters

id*string

The ID of the issue to fetch.

Response

Body

dataIssue (object)

errorsarray of string

The list of errors, if any.

paginationPagination (object)

request_idstring

The request ID for tracking.

Request

const response = await fetch('https://api.usepylon.com/issues/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": {
    "account": {
      "id": "text"
    },
    "assignee": {
      "id": "text"
    },
    "body_html": "text",
    "created_at": "text",
    "csat_responses": [
      {
        "comment": "text"
      }
    ],
    "external_issues": [
      {
        "external_id": "text",
        "link": "text",
        "source": "text"
      }
    ],
    "first_response_time": "text",
    "id": "text",
    "latest_message_time": "text",
    "link": "text",
    "requester": {
      "id": "text"
    },
    "resolution_time": "text",
    "slack": {
      "channel_id": "text",
      "message_ts": "text"
    },
    "source": "slack",
    "state": "text",
    "tags": [
      "text"
    ],
    "team": {
      "id": "text"
    },
    "title": "text",
    "type": "Conversation"
  },
  "errors": [
    "text"
  ],
  "pagination": {
    "cursor": "text",
    "has_next_page": false
  },
  "request_id": "text"
}

Update an existing issue.

PATCHhttps://api.usepylon.com/issues/{id}

Path parameters

id*string

The ID of the issue to update.

Body

assignee_idstring

The ID of there user who should be assigned to this issue.

custom_fieldsarray of CustomFieldValue (object)

An array of custom fields to be used on this issue. Only passed in fields will be modified.

statestring

The state this issue should be moved to. Can be one of new, waiting_on_you, waiting_on_customer, on_hold, closed, or a custom status.

tagsarray of string

An array of strings to use as tags on this issue. If provided, the issue tags will be updated to be exactly the given tags.

team_idstring

The ID of the team this issue should be assigned to.

Response

Body

dataIssue (object)

errorsarray of string

The list of errors, if any.

paginationPagination (object)

request_idstring

The request ID for tracking.

Request

const response = await fetch('https://api.usepylon.com/issues/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "data": {
    "account": {
      "id": "text"
    },
    "assignee": {
      "id": "text"
    },
    "body_html": "text",
    "created_at": "text",
    "csat_responses": [
      {
        "comment": "text"
      }
    ],
    "external_issues": [
      {
        "external_id": "text",
        "link": "text",
        "source": "text"
      }
    ],
    "first_response_time": "text",
    "id": "text",
    "latest_message_time": "text",
    "link": "text",
    "requester": {
      "id": "text"
    },
    "resolution_time": "text",
    "slack": {
      "channel_id": "text",
      "message_ts": "text"
    },
    "source": "slack",
    "state": "text",
    "tags": [
      "text"
    ],
    "team": {
      "id": "text"
    },
    "title": "text",
    "type": "Conversation"
  },
  "errors": [
    "text"
  ],
  "pagination": {
    "cursor": "text",
    "has_next_page": false
  },
  "request_id": "text"
}

PreviousCustom Fields NextKnowledge Base

const response = await fetch('https://api.usepylon.com/issues/{id}', { method: 'PATCH', headers: { "Content-Type": "application/json" }, body: JSON.stringify({}), }); const data = await response.json();

{ "data": { "account": { "id": "text" }, "assignee": { "id": "text" }, "body_html": "text", "created_at": "text", "csat_responses": [ { "comment": "text" } ], "external_issues": [ { "external_id": "text", "link": "text", "source": "text" } ], "first_response_time": "text", "id": "text", "latest_message_time": "text", "link": "text", "requester": { "id": "text" }, "resolution_time": "text", "slack": { "channel_id": "text", "message_ts": "text" }, "source": "slack", "state": "text", "tags": [ "text" ], "team": { "id": "text" }, "title": "text", "type": "Conversation" }, "errors": [ "text" ], "pagination": { "cursor": "text", "has_next_page": false }, "request_id": "text" }

const response = await fetch('https://api.usepylon.com/issues', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "body_html": "text", "title": "text" }), }); const data = await response.json();