Look up a ticket by any identifier

GET/ticket/lookup

Authorization

AuthorizationAPI key · headerrequired

The Incoming Secret value (<secretId>.<random>), with or without a Bearer prefix.

Query parameters

idstring

Ticket id.

customIdstring

Custom ticket id.

ticketSidstring

Short ticket identifier.

projectSidstring

Short order identifier of the confirmed ticket.

Responses

200

OK.

idstring

Ticket ID (autoassigned on create, read-only)

appIdstring

Application ID (autoassigned on create, read-only)

statusNamestring

Ticket status name

prioritystring

Ticket priority

poNumberstring

PO number (create-only, cannot be updated)

quotationFormRegionIdstring

Quotation form region ID

additionalFilesobject

Object keyed by file name: {"fileName": {"url": "http://example.com", "headers": {}}}

401

Authentication failed. All causes return this identical response.

codeinteger

messagestring

typestring

default

Downstream errors pass through verbatim; x-error-source names the failing service.

codeinteger

messagestring

typestring

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

idqueryTicket id.customIdqueryCustom ticket id.ticketSidqueryShort ticket identifier.projectSidqueryShort order identifier of the confirmed ticket.

Request

curl -X GET 'https://next.amfg.ai/engine-service/public-api/v1/ticket/lookup' \
  -H 'Authorization: YOUR_API_KEY'

const response = await fetch("https://next.amfg.ai/engine-service/public-api/v1/ticket/lookup", {
  method: "GET",
  headers: {
    "Authorization": "YOUR_API_KEY"
  }
});

import requests

response = requests.get(
    "https://next.amfg.ai/engine-service/public-api/v1/ticket/lookup",
    headers={
        "Authorization": "YOUR_API_KEY"
    },
)

Response

{
  "customId": "PROJECT-0001",
  "statusName": "New",
  "priority": "LOW",
  "contactEmail": "example@amfg.ai"
}

{
  "code": 401,
  "message": "Not Authorized"
}

{
  "code": 0,
  "message": "string",
  "type": "string"
}