API v1
v1
View as Markdown

Get a support request of the instance

GET /api/v1/admin/support-requests/{supportRequest}

Return one support request of any account, with the whole thread including the internal notes, a few facts about the account, and how the status moved.

Only an administrator of this instance can use these endpoints, and only with an API key that carries the administration scope by name. Anybody else, including an administrator whose key does not carry it, gets 404 as though the endpoint did not exist.

This endpoint also answers QUERY, with the same parameters sent in the request body. How QUERY works.

Path parameters

Sent as JSON. Anything not listed here is ignored.

supportRequest uuid Required

The id of the request, of any account on the instance.

Returns

The support request object. An id that matches no request answers 404.

data object

The support request.

data.type string

Always support_request. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from.

data.id string

The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes.

data.attributes object

Everything the record holds.

data.attributes.reference string

The reference the person quotes when writing to the support team, such as MON-482913.

data.attributes.account_id integer

The account the request was opened from.

data.attributes.user object

Who asked.

data.attributes.user.name string

The name of the person who opened the request, or null once their user is deleted.

data.attributes.user.email string

Where replies are emailed, or null once their user is deleted.

data.attributes.category string

What the request is about: feature, billing, email, question or technical.

data.attributes.subject string

The title the request was opened with.

data.attributes.status string

to_handle when the person is waiting for an answer, waiting_on_user when the team is, or solved.

data.attributes.status_label string

The status as the administrators read it, in the language of the signed in administrator.

data.attributes.application_version string

The version of the application the request was opened from.

data.attributes.locale string

The language the person was using when they opened it.

data.attributes.opened_at timestamp

When the request was opened, as a count of seconds since 1970.

data.attributes.last_activity_at timestamp

When anybody last wrote in it, the person who asked or the support team, as a count of seconds since 1970. A change of status alone does not move it.

data.attributes.solved_at timestamp

When it was marked as solved, as a count of seconds since 1970, or null while it is open.

data.attributes.messages array

The whole thread, the oldest first, with the internal notes.

data.attributes.messages[] object

One message of the thread.

data.attributes.messages[].type string

Always support_message.

data.attributes.messages[].id string

The id of the message.

data.attributes.messages[].attributes object

Everything the message holds.

data.attributes.messages[].attributes.kind string

message when the person wrote it, reply when an administrator answered them, note when an administrator wrote it for the team alone.

data.attributes.messages[].attributes.author_name string

The name of the person who wrote it.

data.attributes.messages[].attributes.is_support_team boolean

Whether an administrator wrote it.

data.attributes.messages[].attributes.body string

What was written, as plain text.

data.attributes.messages[].attributes.attachments array

The files sent with it. An empty list when there are none, which is always the case for a reply or a note written through this API.

data.attributes.messages[].attributes.attachments[] object

One file.

data.attributes.messages[].attributes.attachments[].id uuid

The id of the file.

data.attributes.messages[].attributes.attachments[].name string

The name the file had when it was sent.

data.attributes.messages[].attributes.attachments[].mime_type string

The type of the file, such as image/png.

data.attributes.messages[].attributes.attachments[].size_in_bytes integer

How large the file is, in bytes.

data.attributes.messages[].attributes.created_at timestamp

When it was written, as a count of seconds since 1970.

data.attributes.context array

A few facts about the account, to answer with.

data.attributes.context[] object

One fact.

data.attributes.context[].label string

What the fact is about, such as Version.

data.attributes.context[].value string

The fact.

data.attributes.status_changes array

How the status moved, the oldest first.

data.attributes.status_changes[] object

One change of status.

data.attributes.status_changes[].from string

The status it left, or null for the change that opened the request.

data.attributes.status_changes[].to string

The status it took.

data.attributes.status_changes[].by string

The name of who changed it.

data.attributes.status_changes[].at timestamp

When, as a count of seconds since 1970.

data.links object

Where to find this record.

data.links.self string

The absolute address this record is read from.

Rate limit

Sixty requests per minute, per user, shared by every key and device. Every answer carries the budget left in X-RateLimit-Remaining.

GET
curl https://my.monicahq.com/api/v1/admin/support-requests/7c1e4a92-5b3d-4f08-a6e1-93d2c8b05f17 \
-H "Authorization: Bearer $MONICA_TOKEN"
const response = await fetch('https://my.monicahq.com/api/v1/admin/support-requests/7c1e4a92-5b3d-4f08-a6e1-93d2c8b05f17', {
headers: { Authorization: `Bearer ${token}` },
})
const data = await response.json()
$response = Http::withToken($token)->get('https://my.monicahq.com/api/v1/admin/support-requests/7c1e4a92-5b3d-4f08-a6e1-93d2c8b05f17');
Response 200
{
"data": {
"type": "support_request",
"id": "7c1e4a92-5b3d-4f08-a6e1-93d2c8b05f17",
"attributes": {
"reference": "MON-482913",
"account_id": 12,
"user": {
"name": "Michael Scott",
"email": "[email protected]"
},
"category": "question",
"subject": "My conference room reminder never arrived",
"status": "waiting_on_user",
"status_label": "Waiting on the user",
"application_version": "5.0.0",
"locale": "en",
"opened_at": 1791547200,
"last_activity_at": 1791550800,
"solved_at": null,
"messages": [
{
"type": "support_message",
"id": "e5a90b36-1c7d-4284-b9f3-0d6a82c471e9",
"attributes": {
"kind": "message",
"author_name": "Michael Scott",
"is_support_team": false,
"body": "I booked the conference room for the quarterly meeting, but the reminder never arrived. Dwight says it is a conspiracy.",
"attachments": [
{
"id": "b36f0d8e-47a1-4c92-95e8-1a2d7c63f0b4",
"name": "conference-room-booking.png",
"mime_type": "image/png",
"size_in_bytes": 245760
}
],
"created_at": 1791547200
}
},
{
"type": "support_message",
"id": "2f8d6c14-a093-4b75-8e21-c5b7094d3a68",
"attributes": {
"kind": "reply",
"author_name": "Jim Halpert",
"is_support_team": true,
"body": "Hi Michael. The reminder was set for a time that had already passed, so it was skipped. We have moved it to tomorrow at nine.",
"attachments": [],
"created_at": 1791550800
}
},
{
"type": "support_message",
"id": "8a41c7e5-d209-4b3f-b6a8-5e90f13d7c24",
"attributes": {
"kind": "note",
"author_name": "Jim Halpert",
"is_support_team": true,
"body": "Same account as the ticket about the birthday reminders. Check with Pam before closing.",
"attachments": [],
"created_at": 1791551400
}
}
],
"context": [
{
"label": "Account",
"value": "#12"
},
{
"label": "Access",
"value": "Free plan"
},
{
"label": "Language",
"value": "English"
},
{
"label": "Version",
"value": "5.0.0"
},
{
"label": "Content",
"value": "1 vault, 24 contacts"
},
{
"label": "Signed up",
"value": "March 4, 2026"
}
],
"status_changes": [
{
"from": null,
"to": "to_handle",
"by": "Michael Scott",
"at": 1791547200
},
{
"from": "to_handle",
"to": "waiting_on_user",
"by": "Jim Halpert",
"at": 1791550800
}
]
},
"links": {
"self": "https://my.monicahq.com/api/v1/admin/support-requests/7c1e4a92-5b3d-4f08-a6e1-93d2c8b05f17"
}
}
}

Keys act as you, with exactly the access you have. Make one per integration so you can revoke it alone.