GET/desk/api/v2/contactforms.json

Get a paginated list of contactforms.

The following values are allowed in the filter query parameter:

  • accentColor
  • createdAt
  • createdBy
  • deletedAt
  • deletedBy
  • id
  • inboxFieldName
  • isLiveChatEnabled
  • liveChatWelcomeMessage
  • name
  • position
  • state
  • theme
  • token
  • triggerColor
  • updatedAt
  • updatedBy

The following values are allowed in the orderBy query parameter:

  • accentColor

  • createdAt

  • createdBy

  • deletedAt

  • deletedBy

  • id

  • inboxFieldName

  • isLiveChatEnabled

  • liveChatWelcomeMessage

  • name

  • position

  • state

  • theme

  • token

  • triggerColor

  • updatedAt

  • updatedBy

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

  • inboxes

  • users

  • all

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    ContactFormsAPIBody handles the listing response for contactform.
  • 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

ContactFormsAPIBody
{  "contactforms": [    {      "accentColor": "string",      "createdAt": "2024-12-19T16:02:34.120Z",      "createdBy": {        "delete": true,        "id": 0,        "meta": {          "additionalProp": "Unknown Type: any"        },        "type": 0      },      "deletedAt": "2024-12-19T16:02:34.120Z",      "deletedBy": {        "delete": true,        "id": 0,        "meta": {