GunSpec

Support

Support tickets for the signed-in account. The same thread staff sees in the console, so a reply posted here reaches a person and their answer comes back on the ticket. Session-scoped (/v1/me/*).

Authentifizierung erforderlichExplorer+

Open a ticket.

create(params: CreateTicketParams): Promise<APIResponse<SupportTicket>>
POST/v1/me/support

  • stringHeadererforderlich

    Ihr API-Schlüssel. Authorization: Bearer <key> wird ebenfalls akzeptiert.

  • stringerforderlich

    One-line summary of the issue.

  • stringerforderlich

    Prose summary of the record, where one has been written.

  • string

    What the ticket is about. Not a firearm or attachment category.

  • string

    Triage priority you are asking for. Staff may change it.

  • SupportTicket

    The response payload

  • string

    Opaque ticket id.

  • string

    One-line summary of the issue.

  • string

    Prose summary of the record, where one has been written.

  • TicketStatus

    Lifecycle of a support ticket. waiting means we are waiting on the customer.

  • TicketPriority

    Support ticket priority.

  • string | null

    What the ticket is about: billing, technical, data_quality, feature_request, other.

  • integer

    How many replies the thread holds.

  • string

    When the ticket was opened, ISO 8601.

  • string

    When the ticket last changed, ISO 8601.

  • string | null

    When it was closed, or null while it is open.

  • 400VALIDATION_ERRORValidation error
  • 401UNAUTHORIZEDAPI key required
  • 403FORBIDDENValid key, not permitted
  • 413PAYLOAD_TOO_LARGERequest body too large
  • 429RATE_LIMITEDRate limit exceeded
  • 500INTERNAL_ERRORUnexpected server error

Mindeststufe
Explorer+
Monatskontingent
200/mo
Anfragerate
10/min
Tageslimit
50

Die Werte gelten für die Mindeststufe dieses Endpunkts. Höhere Stufen erhöhen alle Limits.

Authentifizierung erforderlichExplorer+

The account's tickets, newest first.

list(params?: ListTicketsParams): Promise<PaginatedResponse<SupportTicket>>
GET/v1/me/support

  • stringHeadererforderlich

    Ihr API-Schlüssel. Authorization: Bearer <key> wird ebenfalls akzeptiert.

  • integerstandard1

    Page number, from 1 to 10,000

    Bereich
    1 – 10000
    Beispiel
  • integerstandard20

    Items per page (max 100)

    Bereich
    1 – 100
    Beispiel
  • string

    Filter by ticket status

    Akzeptiert
  • stringstandardcreated_at

    Sort field

    Akzeptiert
    Beispiel
  • stringstandarddesc

    Sort order

    Akzeptiert
    Beispiel

  • SupportTicket[]

    One page of results

  • string

    Opaque ticket id.

  • string

    One-line summary of the issue.

  • string

    Prose summary of the record, where one has been written.

  • TicketStatus

    Lifecycle of a support ticket. waiting means we are waiting on the customer.

  • TicketPriority

    Support ticket priority.

  • string | null

    What the ticket is about: billing, technical, data_quality, feature_request, other.

  • integer

    How many replies the thread holds.

  • string

    When the ticket was opened, ISO 8601.

  • string

    When the ticket last changed, ISO 8601.

  • string | null

    When it was closed, or null while it is open.

  • number

    Current page number

  • number

    Items per page

  • number

    Total matching records (Builder and above)

  • 400VALIDATION_ERRORValidation error
  • 401UNAUTHORIZEDAPI key required
  • 403FORBIDDENValid key, not permitted
  • 429RATE_LIMITEDRate limit exceeded
  • 500INTERNAL_ERRORUnexpected server error

Mindeststufe
Explorer+
Monatskontingent
200/mo
Anfragerate
10/min
Tageslimit
50

Die Werte gelten für die Mindeststufe dieses Endpunkts. Höhere Stufen erhöhen alle Limits.

Authentifizierung erforderlichExplorer+

One ticket with its whole conversation.

get(ticketId: string): Promise<APIResponse<SupportTicketDetail>>
GET/v1/me/support/{ticketId}

  • stringHeadererforderlich

    Ihr API-Schlüssel. Authorization: Bearer <key> wird ebenfalls akzeptiert.

  • stringerforderlich

    Support ticket id

    Beispiel

  • SupportTicket

    The response payload

  • string

    Opaque ticket id.

  • string

    One-line summary of the issue.

  • string

    Prose summary of the record, where one has been written.

  • TicketStatus

    Lifecycle of a support ticket. waiting means we are waiting on the customer.

  • TicketPriority

    Support ticket priority.

  • string | null

    What the ticket is about: billing, technical, data_quality, feature_request, other.

  • integer

    How many replies the thread holds.

  • string

    When the ticket was opened, ISO 8601.

  • string

    When the ticket last changed, ISO 8601.

  • string | null

    When it was closed, or null while it is open.

  • object[]

    Every reply on the ticket in the order it was written, staff-internal notes excluded.

  • integer

    Numeric id of the reply.

  • string

    Id of the ticket.

  • string

    Who wrote it: the customer or a staff member.

  • string

    The reply body.

  • string

    When the reply was recorded, ISO 8601 UTC.

  • object[]

    Files attached to the ticket or to one of its replies.

  • integer

    Numeric id of the attachment.

  • string

    Id of the ticket the file belongs to.

  • integer | null

    The reply the file was attached to, or null when it was attached to the ticket itself.

  • string

    Who uploaded it.

  • string

    The name the file was uploaded with.

  • string

    Storage key; download through the ticket attachment endpoint, never by constructing a URL from this.

  • integer

    Bytes.

  • string

    Media type as detected at upload.

  • string

    When the file was attached, ISO 8601 UTC.

  • 400VALIDATION_ERRORValidation error
  • 401UNAUTHORIZEDAPI key required
  • 403FORBIDDENValid key, not permitted
  • 404NOT_FOUNDResource not found
  • 429RATE_LIMITEDRate limit exceeded
  • 500INTERNAL_ERRORUnexpected server error

Mindeststufe
Explorer+
Monatskontingent
200/mo
Anfragerate
10/min
Tageslimit
50

Die Werte gelten für die Mindeststufe dieses Endpunkts. Höhere Stufen erhöhen alle Limits.

Authentifizierung erforderlichExplorer+

Add a message to an open ticket.

reply(ticketId: string, params: CreateReplyParams): Promise<APIResponse<SupportTicketReply>>
POST/v1/me/support/{ticketId}/replies

  • stringHeadererforderlich

    Ihr API-Schlüssel. Authorization: Bearer <key> wird ebenfalls akzeptiert.

  • stringerforderlich

    Support ticket id

    Beispiel

  • stringerforderlich

    The reply body. Plain text.

  • object

    The response payload.

  • integer

    Numeric id of the reply.

  • string

    Id of the ticket the reply was added to.

  • string

    The reply body, as sent.

  • string

    When the reply was recorded, ISO 8601 UTC.

  • 400VALIDATION_ERRORValidation error
  • 401UNAUTHORIZEDAPI key required
  • 403FORBIDDENValid key, not permitted
  • 404NOT_FOUNDResource not found
  • 413PAYLOAD_TOO_LARGERequest body too large
  • 429RATE_LIMITEDRate limit exceeded
  • 500INTERNAL_ERRORUnexpected server error

Mindeststufe
Explorer+
Monatskontingent
200/mo
Anfragerate
10/min
Tageslimit
50

Die Werte gelten für die Mindeststufe dieses Endpunkts. Höhere Stufen erhöhen alle Limits.