tickets

Get a ticket

Returns a single ticket with all related data.

GET

/v1/tickets/{id}

Get a ticket

curl --request GET \
  --url https://api.beamdynamics.io/v1/tickets/{id} \
  --header 'beam-api-key: <api-key>'

{
  "asset": "<any>",
  "assignee": {
    "userAvatar": "<string>",
    "userId": "<string>",
    "userName": "<string>"
  },
  "assignees": [
    {
      "email": "<string>",
      "userAvatar": "<string>",
      "userId": "<string>",
      "userName": "<string>"
    }
  ],
  "attributes": "<any>",
  "closedAt": "<any>",
  "contact": {
    "email": "<string>",
    "firstName": "<string>",
    "id": "<string>",
    "lastName": "<string>",
    "pictureUrl": "<string>"
  },
  "contactEntityId": "<string>",
  "contacts": [
    {
      "email": "<string>",
      "firstName": "<string>",
      "id": "<string>",
      "lastName": "<string>",
      "pictureUrl": "<string>"
    }
  ],
  "createdAt": "<any>",
  "createdBy": {
    "userAvatar": "<string>",
    "userId": "<string>",
    "userName": "<string>"
  },
  "customFieldAssets": "<any>",
  "description": "<string>",
  "dueDate": "<any>",
  "email": "<string>",
  "fields": [
    {
      "content": "<string>",
      "customField": {
        "id": "<string>",
        "name": "<string>",
        "ticketTypeId": "<string>",
        "type": "<string>"
      },
      "id": "<string>"
    }
  ],
  "id": 123,
  "isInternal": true,
  "isNotCreated": true,
  "locations": [
    {
      "color": "<string>",
      "icon": "<string>",
      "id": "<string>",
      "name": "<string>",
      "nestedLevel": 123
    }
  ],
  "maintenance": [
    {
      "description": "<string>",
      "endDate": "<any>",
      "id": "<string>",
      "seqId": "<string>",
      "startDate": "<any>",
      "status": {
        "category": "<string>",
        "color": "<string>",
        "id": "<string>",
        "name": "<string>"

Authorizations

beam-api-keystringheaderrequired

Path Parameters

idintegerrequired

Required range: 0 < x

Response

The ticket

assetany | null

assigneeobject | nullrequired

Show child attributes

assigneesobject[]required

Show child attributes

attributesany | null

closedAtany | null

contactobject | nullrequired

Show child attributes

contactEntityIdstring | nullrequired

contactsobject[]required

Show child attributes

createdAtany | null

createdByobject | nullrequired

Show child attributes

customFieldAssetsany | null

descriptionstring | nullrequired

dueDateany | null

emailstring | nullrequired

fieldsobject[]required

Show child attributes

idnumberrequired

isInternalbooleanrequired

isNotCreatedbooleanrequired

locationsobject[]required

Show child attributes

maintenanceobject[]required

Show child attributes

manufacturerany | null

mgHistory(any | null)[]required

primaryEquipmentIdstring | nullrequired

prioritystring | nullrequired

productsany | null

publicMessageUnreadbooleanrequired

purchaseobject[]required

Show child attributes

seqIdnumberrequired

statusobject | nullrequired

Show child attributes

statusIdstringrequired

subStatusstring | nullrequired

tagCategoryany | null

tagsany | null

ticketTypeIdstringrequired

titlestringrequired

urlstringrequired

Still need help? Ask the team