Shop It Docs
Developer ResourcesSupport

Support Requests Admin API Reference

Integration reference for admin support request endpoints.

Support Requests Admin API Reference

Audience: Admin/frontend developers, API consumers Scope: Admin support request contracts currently implemented.


Admin APIs

List Support Requests

Endpoint

GET /api/admin/support-requests

Auth

  • Authorization: Bearer <admin-jwt>
  • Requires admin permission: SupportRequests_READ

Query params

ParamTypeRequiredExampleNotes
statusstringNoopenopen, in_progress, resolved, closed
categorystringNotechnicalaccount, payment, technical, other
customerIdstringNouuidFilter by customer
assignedAdminIdstringNouuidFilter by assignee
searchstringNologinMatches subject
pagenumberNo1Default 1
sizenumberNo20Default 20, max 100

Get Support Request Detail

Endpoint

GET /api/admin/support-requests/{id}

Returns support metadata plus chronological message thread.

Response (messages shape)

{
	"message": "Support request fetched successfully",
	"data": {
		"id": 1,
		"customerId": "customer-uuid",
		"category": "technical",
		"subject": "App crashes on checkout",
		"status": "in_progress",
		"assignedAdminId": "admin-uuid",
		"resolutionNote": null,
		"resolvedAt": null,
		"closedAt": null,
		"lastCustomerMessageAt": "2026-03-17T10:05:00.000Z",
		"lastAdminMessageAt": "2026-03-17T10:06:00.000Z",
		"messages": [
			{
				"id": 10,
				"supportRequestId": 1,
				"authorType": "customer",
				"authorCustomerId": "customer-uuid",
				"authorAdminId": null,
				"authorName": "Alex Customer",
				"authorImage": "https://cdn.example.com/customer.png",
				"body": "App crashes on checkout.",
				"createdAt": "2026-03-17T10:04:00.000Z"
			},
			{
				"id": 11,
				"supportRequestId": 1,
				"authorType": "admin",
				"authorCustomerId": null,
				"authorAdminId": "admin-uuid",
				"authorName": "Support Agent",
				"authorImage": "https://cdn.example.com/admin.png",
				"body": "Thanks, we are looking into it.",
				"createdAt": "2026-03-17T10:06:00.000Z"
			}
		],
		"createdAt": "2026-03-17T10:00:00.000Z",
		"updatedAt": "2026-03-17T10:06:00.000Z"
	}
}

Update Support Status

Endpoint

PATCH /api/admin/support-requests/{id}/status

Auth

  • Requires admin permission: SupportRequests_UPDATE

Request body

{
	"status": "resolved",
	"resolutionNote": "Customer confirmed the issue is fixed."
}

Rules:

  • resolutionNote is only valid for resolved or closed
  • mobile user replies are blocked once status becomes closed

Assign Support Request

Endpoint

PATCH /api/admin/support-requests/{id}/assign

Request body

{
	"assignedAdminId": "admin-uuid"
}

Send null to clear assignment.

Add Admin Reply

Endpoint

POST /api/admin/support-requests/{id}/messages

Request body

{
	"body": "We are reviewing this issue now."
}