GET/desk/api/v2/customerportals.json
Get all customerportals.
The following values are allowed in the filter query parameter:
- bodyColor
- bodyLinks
- bodyText
- button
- buttonText
- canCloseTicket
- canEditTags
- canSeeAgent
- canSeeLastRead
- canSeeTags
- canSetPriority
- canSetType
- createdAt
- createdBy
- customDomain
- customerWelcomeEmail
- customerWelcomeSubject
- deletedAt
- deletedBy
- enabled
- header
- headerLinks
- icon
- id
- inboxFieldName
- language
- search
- searchText
- sendCustomerWelcome
- state
- styleHelpDocsId
- stylesheetURL
- updatedAt
- updatedBy
The following values are allowed in the orderBy query parameter:
-
bodyColor
-
bodyLinks
-
bodyText
-
button
-
buttonText
-
canCloseTicket
-
canEditTags
-
canSeeAgent
-
canSeeLastRead
-
canSeeTags
-
canSetPriority
-
canSetType
-
createdAt
-
createdBy
-
customDomain
-
customerWelcomeEmail
-
customerWelcomeSubject
-
deletedAt
-
deletedBy
-
enabled
-
header
-
headerLinks
-
icon
-
id
-
inboxFieldName
-
language
-
search
-
searchText
-
sendCustomerWelcome
-
state
-
styleHelpDocsId
-
stylesheetURL
-
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
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.
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": "2025-11-03T20:04:10.803Z", "createdBy": { "delete": true,