Get pending helpdesk messages

/helpdesk_messages/get_pending_messages

Target audience: Developers

Release version: 3.9.1

Get pending helpdesk messages for an account¶

Introduction¶

This endpoint returns all pending helpdesk messages for the account id supplied.

URI¶

Environment	URI
Stage	https://payway-api.stage.adeprimo.se/external/api/v1/helpdesk_messages/get_pending_messages
Production	https://backend.worldoftulo.com/external/api/v1/helpdesk_messages/get_pending_messages

Requirements¶

Identity	Scope
No	`/external/helpdesk/r`

Parameters¶

Name	Required	Type	Description
account_id	Required	String	The account id. Size range: ..24 Allowed values: "/^[a-f\d]{24}$/i"

Curl Example¶

curl --request GET \
  --url https://payway-api.stage.adeprimo.se/external/api/v1/helpdesk_messages/get_pending_messages?account_id=66166781ad659dfeb3320fe6 \
  --header 'accept: application/json' \
  --header 'authorization: Bearer <token>'

Response¶

Example response¶

HTTP 200
{
  "items": [
    {
      "id": "67e68274ad659dbe3b3fcb55",
      "account_id": "66d986b4ad659dea5ceb9b62",
      "account": {
        "id": "66d986b4ad659dea5ceb9b62",
        "first_name": "Johm",
        "last_name": "Doe",
        "contact_email": "john@doe.com",
        "mobile_number": "0441231234",
        "customer_number": null,
        "status": "active",
        "verified": false,
        "has_products": true
      },
      "assignee_id": "59d345e3400e067e7700000c",
      "assignee": {
        "id": "59d345e3400e067e7700000c",
        "first_name": "Sarah",
        "last_name": "Servicedesk",
        "contact_email": "sarah@servicedesk.com",
        "mobile_number": "+46701231234",
        "customer_number": null,
        "status": "active",
        "verified": false
      },
      "created_at": "2025-03-28T12:05:24.389+01:00",
      "updated_at": "2025-03-28T12:55:42.802+01:00",
      "resolved_at": null,
      "heading": "My heading",
      "message": "My message",
      "type": "request",
      "identifier": "",
      "state": "pending",
      "comments": []
    }
  ]
}

Errors¶

Example error response¶

HTTP 400 Bad Request
{
  "code": "invalid_parameter",
  "field": "account_id",
  "message": "Parameter cannot have length greater than 24",
  "pw_correlation_id": "pw-api-80c12a6b-afa6-46cf-a7dc-7a3a88c06344"
}

HTTP 400 Bad Request¶

Name	Type	Description
unknown_parameter	Object	One or more of the fields in the posted json was not recognized

HTTP 404 Not Found¶

Name	Type	Description
not_found	Object	The account could not be found

HTTP 500 Internal Server Error¶

Name	Type	Description
internal_server_error	Object	Something unexpected happened server side