Get my support ticket

Returns one support ticket and its complete conversation only when the acting PAT/OAuth user is the ticket opener. A ticket belonging to another user is reported as not found.

GET/support/tickets/{ticketId}

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:read

AuthorizationBearer token (JWT) · headerrequired

Path parameters

ticketIdstringrequired

Support ticket UUID.

Responses

200

Ticket details and complete conversation.

createdAtstring<date-time>required

When the ticket was opened.

idstringrequired

Support ticket UUID.

lastMessageAtstring<date-time>required

When the newest message was created.

lastMessageAuthorSidestringrequired

Which side wrote the newest message.

Allowed:UserAdmin

lastMessageTextBodystringrequired

Plain-text preview of the newest message.

messagesSupportMessageDto[]required

Complete conversation ordered from oldest to newest.

Show properties

Array of SupportMessageDto

authorSidestringrequired

Whether the opener or the Leadtime team wrote the message.

Allowed:UserAdmin

authorUserIdobject | nullrequired

The ticket opener user UUID for opener-authored messages. Null for Leadtime team messages.

bodystringrequired

Message body rendered as HTML.

createdAtstring<date-time>required

When the message was created.

idstringrequired

Support message UUID.

manageAuthorobject | nullrequired

Name and avatar of the Leadtime team member for team-authored messages. Never contains an email address.

Show properties

avatarobject | nullrequired

Avatar configuration for the Leadtime team member. Null when no avatar is configured.

Show properties

idstringrequired

Stable avatar configuration identifier.

kindstringrequired

How the support team member avatar is rendered.

Allowed:generateduploadedleadtimeAgent

optionsobject

Generated-avatar rendering options.

stylestring

Generated-avatar style when kind is generated.

Allowed:adventurerbotttsinitialspersonasnotionistsdylanbottts-neutral

namestringrequired

Display name of the Leadtime team member.

textBodystringrequired

Plain-text message body for summaries and search.

statusstringrequired

Current ticket status.

Allowed:OpenClosed

titlestringrequired

Generated ticket title, or the immediate first-message fallback while generation is running.

titleIsGeneratingbooleanrequired

Whether a generated title is still being prepared.

unreadbooleanrequired

Whether the acting opener has an unread message from the Leadtime team.

userLastSeenAtobject<date-time> | nullrequired

When the ticket opener last viewed the conversation.

400

The ticket identifier is not a valid UUID.

401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient API scopes or permissions

404

Ticket not found for the acting user.

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

Parameters

ticketIdpath*Support ticket UUID.

Request

curl -X GET "https://leadtime.app/api/public/support/tickets/string" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

const response = await fetch("https://leadtime.app/api/public/support/tickets/string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
  }
});

import requests

response = requests.get(
    "https://leadtime.app/api/public/support/tickets/string",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN"
    },
)

Response

{
  "createdAt": "2019-08-24T14:15:22Z",
  "id": "5532b85e-bef7-48c9-9272-9de7c63a1234",
  "lastMessageAt": "2019-08-24T14:15:22Z",
  "lastMessageAuthorSide": "User",
  "lastMessageTextBody": "The project page stays blank after I select it.",
  "messages": [
    {
      "authorSide": "User",
      "authorUserId": "65bc3ac7-d43b-43c9-b3f2-4bd3b46c96bc",
      "body": "<p>The project page stays blank after I select it.</p>",
      "createdAt": "2019-08-24T14:15:22Z",
      "id": "81008f98-5921-4acb-936b-62d122d1fcfd",
      "manageAuthor": {
        "avatar": {
          "id": "9c26ca8f-fc9a-40fc-b5e0-ec0aa344f6fd",
          "kind": "generated",
          "options": {},
          "style": "adventurer"
        },
        "name": "Alex Morgan"
      },
      "textBody": "The project page stays blank after I select it."
    }
  ],
  "status": "Open",
  "title": "Project page stays blank",
  "titleIsGenerating": true,
  "unread": true,
  "userLastSeenAt": {}
}