Issues

Get a list of issues.

GEThttps://api.usepylon.com/issues

Query parameters

Response

200400404500

Body

application/json

dataarray of Issue (object)

The data payload of the response.

paginationPagination (object)

request_idstring

The request ID for tracking.

Request

JavaScriptCurlPython

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

Response

200400404500

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

Create a new issue.

POSThttps://api.usepylon.com/issues

Body

application/json

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.

created_atstring

Timestamp of when the issue was created. If not specified, the current time will be used. (RFC3339)

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

200400404500

Body

application/json

dataIssue (object)

request_idstring

The request ID for tracking.

Request

JavaScriptCurlPython

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

200400404500

{
  "data": {
    "account": {
      "id": "text"
    },
    "assignee": {
      "id": "text"
    },
    "body_html": "text",
    "business_hours_first_response_seconds": 0,
    "business_hours_resolution_seconds": 0,
    "created_at": "text",
    "csat_responses": [
      {
        "comment": "text",
        "score": 0
      }
    ],
    "customer_portal_visible": false,
    "external_issues": [
      {
        "external_id": "text",
        "link": "text",
        "source": "text"
      }
    ],
    "first_response_seconds": 0,
    "first_response_time": "text",
    "id": "text",
    "latest_message_time": "text",
    "link": "text",
    "number": 0,
    "requester": {
      "id": "text"
    },
    "resolution_seconds": 0,
    "resolution_time": "text",
    "slack": {
      "channel_id": "text",
      "message_ts": "text"
    },
    "source": "slack",
    "state": "text",
    "tags": [
      "text"
    ],
    "team": {
      "id": "text"
    },
    "title": "text",
    "type": "Conversation"
  },
  "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

200400404500

Body

application/json

dataIssue (object)

request_idstring

The request ID for tracking.

Request

JavaScriptCurlPython

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

Response

200400404500

{
  "data": {
    "account": {
      "id": "text"
    },
    "assignee": {
      "id": "text"
    },
    "body_html": "text",
    "business_hours_first_response_seconds": 0,
    "business_hours_resolution_seconds": 0,
    "created_at": "text",
    "csat_responses": [
      {
        "comment": "text",
        "score": 0
      }
    ],
    "customer_portal_visible": false,
    "external_issues": [
      {
        "external_id": "text",
        "link": "text",
        "source": "text"
      }
    ],
    "first_response_seconds": 0,
    "first_response_time": "text",
    "id": "text",
    "latest_message_time": "text",
    "link": "text",
    "number": 0,
    "requester": {
      "id": "text"
    },
    "resolution_seconds": 0,
    "resolution_time": "text",
    "slack": {
      "channel_id": "text",
      "message_ts": "text"
    },
    "source": "slack",
    "state": "text",
    "tags": [
      "text"
    ],
    "team": {
      "id": "text"
    },
    "title": "text",
    "type": "Conversation"
  },
  "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

application/json

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.

customer_portal_visibleboolean

Whether the issue should be visible in the customer portal.

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

200400404500

Body

application/json

dataIssue (object)

request_idstring

The request ID for tracking.

Request

JavaScriptCurlPython

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

200400404500

{
  "data": {
    "account": {
      "id": "text"
    },
    "assignee": {
      "id": "text"
    },
    "body_html": "text",
    "business_hours_first_response_seconds": 0,
    "business_hours_resolution_seconds": 0,
    "created_at": "text",
    "csat_responses": [
      {
        "comment": "text",
        "score": 0
      }
    ],
    "customer_portal_visible": false,
    "external_issues": [
      {
        "external_id": "text",
        "link": "text",
        "source": "text"
      }
    ],
    "first_response_seconds": 0,
    "first_response_time": "text",
    "id": "text",
    "latest_message_time": "text",
    "link": "text",
    "number": 0,
    "requester": {
      "id": "text"
    },
    "resolution_seconds": 0,
    "resolution_time": "text",
    "slack": {
      "channel_id": "text",
      "message_ts": "text"
    },
    "source": "slack",
    "state": "text",
    "tags": [
      "text"
    ],
    "team": {
      "id": "text"
    },
    "title": "text",
    "type": "Conversation"
  },
  "request_id": "text"
}

Delete an existing issue.

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

Path parameters

id*string

The ID of the issue to delete.

Response

200

Body

application/json

request_idstring

The request ID for tracking.

Request

JavaScriptCurlPython

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

Response

200

{
  "request_id": "text"
}

Search for issues by a given filter.

Currently, the following fields are filterable for issues:

• created_at (in RFC3339 format)

• account_id

• ticket_form_id

• requester_id

• state

• custom fields (pass in the slug of the custom field)

POSThttps://api.usepylon.com/issues/search

Body

application/json

cursorstring

The cursor to use for pagination.

filter*Filter (object)

limitinteger (int64)

The number of issues to fetch. Defaults to 100. Must be greater than 0 and less than 1000.

Response

200400404500

Body

application/json

dataarray of Issue (object)

paginationPagination (object)

request_idstring

Request

JavaScriptCurlPython

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

Response

200400404500

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