GET/desk/api/v2/pinnednotes.json

Get a paginated list of pinnednotes.

The following values are allowed in the filter query parameter:

  • createdAt
  • createdBy
  • deletedAt
  • deletedBy
  • id
  • state
  • updatedAt
  • updatedBy

The following values are allowed in the orderBy query parameter:

  • createdAt

  • createdBy

  • deletedAt

  • deletedBy

  • id

  • state

  • updatedAt

  • updatedBy

         The following values are allowed in the [includes](https://apidocs.teamwork.com/guides/desk/relationships-and-includes) query parameter:
     
    
  • messages

  • tickets

  • users

  • all

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    PinnedNotesAPIBody represents the request/response on pinnednotes listing
  • 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

PinnedNotesAPIBody
{  "groups": {    "groups": [      {        "keys": {          "additionalProp": "Unknown Type: any"        },        "values": {          "additionalProp": "Unknown Type: any"        }      }    ],    "truncated": true  },  "included": {    "messages": [      {        "agentsNotified": [