Retrieving Issues

Retrieve Issue data from SpeakUp for reporting, analytics, or to keep an external system in sync. The API returns case details, custom field values, form responses, and report metadata.

Two endpoints provide this. The list endpoint returns IDs and timestamps for every Issue your integration can access. The detail endpoint returns one Issue in full. Start with the list to find the id you need, then fetch that Issue by ID.

To update an Issue in SpeakUp, see Updating Issues.

On this page: Endpoints · Permissions · List Issues · Get an Issue · Errors

Endpoints

Permissions

Requires an App Integration with read only or full access for Issues. See how do I create an App Integration and get API credentials?

List Issues

GET /v1/public/issues

Returns an array of Issues with basic information only. Use the returned id to fetch an Issue in full.

curl -X GET '{API_BASE_URL}/v1/public/issues' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Example response:

[
  {
    "id": 1,
    "customId": "SUP-2024-01",
    "createdAt": "2025-05-26T07:15:48.663Z",
    "updatedAt": "2025-07-20T00:00:51.522Z"
  },
  {
    "id": 2,
    "customId": "SUP-2024-02",
    "createdAt": "2025-05-26T07:16:09.739Z",
    "updatedAt": "2025-07-21T10:14:44.036Z"
  }
]

Get an Issue

GET /v1/public/issues/{id}

Returns full detail for one Issue, including its custom fields, forms, and report details.

curl -X GET '{API_BASE_URL}/v1/public/issues/1001' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Example response, with the nested arrays collapsed. Each is described in its own section below.

{
  "id": 1001,
  "summary": "Security incident involving unauthorized access",
  "description": "A comprehensive security incident report.",
  "type": "Case",
  "status": "Closed",
  "resolution": "Resolved",
  "assignee": "Sarah Johnson",
  "assigneeId": 45,
  "domain": "IT Security",
  "labels": ["Security", "High Priority"],
  "customId": "SEC-2024-001",
  "dueDate": "2024-12-15T17:00:00.000Z",
  "parentId": null,
  "acknowledgedAt": "2024-12-01T09:15:30.123Z",
  "receivedAt": "2024-12-01T09:10:15.456Z",
  "closedAt": "2024-12-10T16:45:22.789Z",
  "createdAt": "2024-12-01T09:10:15.456Z",
  "updatedAt": "2024-12-10T16:45:22.789Z",
  "issueFields": [ ... ],
  "issueForms": [ ... ],
  "reportForms": [ ... ],
  "reportDetails": { ... }
}

Query parameters

By default the response contains the Issue only. Set any of these parameters to true to include related data. They can be combined in a single request.

When a parameter is not supplied, its key is absent from the response. Values are case sensitive, so use lowercase true.

Each parameter can be used on its own:

curl -X GET '{API_BASE_URL}/v1/public/issues/1001?messages=true' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Or combined in one request:

curl -X GET '{API_BASE_URL}/v1/public/issues/1001?messages=true&attachments=true&links=true' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response fields

Timestamps are ISO 8601. Any field that is not set is returned as null. Custom field and form values are returned as strings, including numbers and booleans.

issueFields

Every field defined for the Issue type is returned, including those not yet filled in, so you can see everything available to read or update. Unfilled fields return a value of null.

This response is where you find valid issueFieldId values and their types. You need both before updating custom fields.

issueForms

Forms attached to the Issue by case handlers. An Issue with no forms returns an empty array.

Each entry in fields contains:

reportForms

Forms submitted by the reporter. An Issue with no report forms returns an empty array.

Report form fields carry one field that Issue form fields do not, translatedValue:

reportDetails

Present only when the Issue originated from a report. Issues that did not come from a report return null.

Name and ID pairs are listed together below. Both are returned as separate keys, for example reportLanguage and reportLanguageId.

Linked Issues

With links=true, the response gains a links key. Each entry describes one relationship between two Issues. An Issue with no links returns an empty array.

Links are bidirectional. Querying an Issue returns every link in which it appears, whether as fromIssueId or as toIssueId, and the same link record appears on both Issues.

Errors

See the API error reference for the full list.

Related

• Updating Issues
• Retrieving messages
• Downloading attachments