Listing tickets (for contact)

This method allows you to return all the tickets which have been reported by the passed contact.

URL

/api/v2/tickets/contact

Access

This method can be accessed by account tokens only.

Supported Parameters

  • contact - the reference, name or ID of the contact you wish to look up (required)
  • brand - the name or ID of a brand to restrict returned tickets to the specified brand (optional, returns all brands by default)
  • page - the page number to return tickets for (optional, defaults to 1)
  • sort_by - the name of a field to sort results by (optional, must be one of updated_at, created_at, reference, subject, last_update_posted_at, reply_due_at, resolution_due_at, first_response_time, first_resolution_time, resolution_time)
  • order - the direction you wish to sort results (optional, must be 'asc' or 'desc', defaults to 'asc')

Returned Data

The API will return information about the contact as well as paginated ticket results (30 per page).

Example JSON

{
  "pagination": {
    "page": 1,
    "offset": 0,
    "per_page": 30,
    "pages": 1,
    "total_records": 1
  },
  "records": [
    {
      "id": 1,
      "reference": "GL-516421",
      "subject": "asd",
      "message_id": "42f6987a-50d0-431c-27f7-550d69245ae5@sirportly.dev",
      "submitted_at": "2012-03-23T10:32:24+00:00",
      "reply_due_at": null,
      "resolution_due_at": null,
      "auth_code": "a3m2a8weobmw",
      "additional_recipients": null,
      "last_update_posted_at": "2012-03-23T10:32:24+00:00",
      "first_response_time": "0.01",
      "first_resolution_time": null,
      "resolution_time": null,
      "last_respondant": "user",
      "update_count": 1,
      "status": {
        "id": 1,
        "name": "New",
        "colour": "77c300",
        "status_type": 0
      },
      "priority": {
        "id": 3,
        "name": "Normal",
        "colour": "0097cf",
        "position": 3
      },
      "department": {
        "id": 3,
        "name": "Technical Support",
        "private": false
      },
      "team": {
        "id": 2,
        "name": "Support"
      },
      "user": null,
      "sla": null,
      "contact": {
        "id": 4,
        "reference": "",
        "name": "Adam Cooke",
        "abbreviated_name": "Adam C",
        "company": "",
        "pin": "423429",
        "created_at": "2012-03-23T10:32:24+00:00"
      },
      "contact_method": {
        "id": 1,
        "method_type": "email",
        "data": "adam@atechmedia.com",
        "default": true
      }
    }
  ],
  "contact": {
    "id": 4,
    "reference": "",
    "name": "Adam Cooke",
    "abbreviated_name": "Adam C",
    "company": "",
    "pin": "423429",
    "created_at": "2012-03-23T10:32:24+00:00"
  }
}