Knowledge Base Website Changelog Book a Demo Login

Issues

PreviousCustom Fields NextKnowledge Base

Last updated 1 month ago

Was this helpful?

Get a list of issues

get

/issues

Authorizations

Query parameters

start_timestringrequired

The start time (RFC3339) of the time range to get issues for. The duration between start_time and end_time must be less than or equal to 30 days.

end_timestringrequired

The end time (RFC3339) of the time range to get issues for. The duration between start_time and end_time must be less than or equal to 30 days.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.usepylon.com/issues?start_time=text&end_time=text' \
  --header 'Authorization: Bearer JWT'

200

400

404

500

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

Create a new issue

post

/issues

Authorizations

Body

destination_metadataobject

account_idstring

The account that this issue belongs to.

assignee_idstring

The user the issue should be assigned to.

body_htmlstringrequired

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)

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. Include one of requester_id or requester_email to create an issue with a requester.

requester_idstring

The requester that this issue is on behalf of. Include one of requester_id or requester_email to create an issue with a requester.

requester_namestring

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

team_idstring

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

titlestringrequired

The title of the issue.

attachment_urlsstring[]

An array of attachment URLs to attach to this issue.

custom_fieldsobject[]

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

tagsstring[]

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.usepylon.com/issues' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"destination_metadata":{"email_bccs":[null],"email_ccs":[null]},"body_html":"text","title":"text","attachment_urls":[null],"custom_fields":[{"values":[null]}],"tags":[null]}'

200

400

404

500

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

Get an issue by its ID/number

get

/issues/{id}

Authorizations

Path parameters

idstringrequired

The ID or number of the issue to fetch.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.usepylon.com/issues/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

404

500

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

Update an existing issue

patch

/issues/{id}

Authorizations

Path parameters

idstringrequired

The ID of the issue to update.

Body

assignee_idstring

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

customer_portal_visibleboolean

Whether the issue should be visible in the customer portal.

requestor_idstring

The ID of the requester that this issue is on behalf of.

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.

team_idstring

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

custom_fieldsobject[]

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

tagsstring[]

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.usepylon.com/issues/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"custom_fields":[{"values":[null]}],"tags":[null]}'

200

400

404

500

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

Delete an existing issue

delete

/issues/{id}

Authorizations

Path parameters

idstringrequired

The ID of the issue to delete.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.usepylon.com/issues/{id}' \
  --header 'Authorization: Bearer JWT'

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)
tags (pass in the tag name)

post

/issues/search

Authorizations

Body

filterobjectrequired

cursorstring

The cursor to use for pagination.

limitinteger int64

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.usepylon.com/issues/search' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"filter":{"field":"text","operator":"equals","subfilters":[{"field":"text","operator":"equals","subfilters":[{"field":"text","operator":"equals","subfilters":"[Circular Reference]","values":[null]}],"values":[null]}],"values":[null]}}'

200

400

404

500

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