GET/desk/api/v2/pinnednotes/{id}.json

Get a single pinnednote by id.

The following values are allowed in the includes query parameter:

  • messages
  • tickets
  • users
  • all

Path Params

  • Name
    id
    Type
    integer
    required
    Description

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    PinnedNoteAPIBody represents the request/response on pinnednotes get/create/patch
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    Validator hold the validation errors. Typically you shouldn't create this directly but use the New() function.

Examples

200 OK

PinnedNoteAPIBody
{  "included": {    "messages": [      {        "agentsNotified": [          {            "delete": true,            "id": 0,            "meta": {              "additionalProp": "Unknown Type: any"            },            "type": 0          }        ],        "archivedTickets_id": {          "delete": true,          "id": 0,          "meta": {
Download Swagger