GET/desk/api/v2/customerportals.json

Get all customerportals.

The following values are allowed in the filter query parameter:

  • id
  • enabled
  • canSeeAgent
  • canSeeLastRead
  • canSetPriority
  • canSeeTags
  • canEditTags
  • canCloseTicket
  • canSetType
  • bodyColor
  • bodyLinks
  • bodyText
  • button
  • buttonText
  • search
  • searchText
  • header
  • headerLinks
  • styleHelpDocsId
  • language
  • customDomain
  • inboxFieldName
  • sendCustomerWelcome
  • customerWelcomeSubject
  • customerWelcomeEmail
  • icon
  • stylesheetURL
  • createdAt
  • updatedAt
  • deletedAt
  • createdBy
  • updatedBy
  • deletedBy
  • state

The following values are allowed in the orderBy query parameter:

  • id
  • enabled
  • canSeeAgent
  • canSeeLastRead
  • canSetPriority
  • canSeeTags
  • canEditTags
  • canCloseTicket
  • canSetType
  • bodyColor
  • bodyLinks
  • bodyText
  • button
  • buttonText
  • search
  • searchText
  • header
  • headerLinks
  • styleHelpDocsId
  • language
  • customDomain
  • inboxFieldName
  • sendCustomerWelcome
  • customerWelcomeSubject
  • customerWelcomeEmail
  • icon
  • stylesheetURL
  • createdAt
  • updatedAt
  • deletedAt
  • createdBy
  • updatedBy
  • deletedBy
  • state

Responses

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

CustomerPortalsAPIBody
{  "customerportal": [    {      "bodyColor": "string",      "bodyLinks": "string",      "bodyText": "string",      "button": "string",      "buttonText": "string",      "canCloseTicket": true,      "canEditTags": true,      "canSeeAgent": true,      "canSeeLastRead": true,      "canSeeTags": true,      "canSetPriority": true,      "canSetType": true,      "createdAt": "2024-04-24T00:52:20.157Z",      "createdBy": {        "delete": true,