GET/desk/api/v2/domains.json

Get a paginated list of domains.

The following values are allowed in the filter query parameter:

company
createdAt
createdBy
deletedAt
deletedBy
id
name
project
state
updatedAt
updatedBy

The following values are allowed in the orderBy query parameter:

company
createdAt
createdBy
deletedAt
deletedBy
id
name
name
project
state
updatedAt
updatedBy

Responses

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

DomainsAPIBody

{
  "domains": [
    {
      "company": {
        "delete": true,
        "id": 0,
        "meta": {
          "additionalProp": "Unknown Type: any"
        },
        "type": 0
      },
      "createdAt": "2024-12-19T16:02:17.198Z",
      "createdBy": {
        "delete": true,
        "id": 0,
        "meta": {
          "additionalProp": "Unknown Type: any"
        },
        "type": 0
      },
      "deletedAt": "2024-12-19T16:02:17.198Z",
      "deletedBy": {
        "delete": true,
        "id": 0,
        "meta": {
          "additionalProp": "Unknown Type: any"
        },
        "type": 0
      },
      "filter_args": {
        "aggregate": {
          "Distinct": true,
          "Field": "string",
          "Operation": "string"
        },
        "bulkDryExecute": true,
        "fields": [
          "string"
        ],
        "filter": [
          "string"
        ],
        "id": 0,
        "ids": [
          0
        ],
        "includes": [
          "string"
        ],
        "orderBy": "string",
        "orderMode": "asc",
        "page": 0,
        "pageOffset": 0,
        "pageSize": 0,
        "skipAggregation": true
      },
      "id": 0,
      "name": "string",
      "project": {
        "delete": true,
        "id": 0,
        "meta": {
          "additionalProp": "Unknown Type: any"
        },
        "type": 0
      },
      "projects_company": {
        "delete": true,
        "id": 0,
        "meta": {
          "additionalProp": "Unknown Type: any"
        },
        "type": 0
      },
      "state": "string",
      "updatedAt": "2024-12-19T16:02:17.198Z",
      "updatedBy": {
        "delete": true,
        "id": 0,
        "meta": {
          "additionalProp": "Unknown Type: any"
        },
        "type": 0
      }
    }
  ],
  "included": {
    "users": [
      {
        "autoFollowOnCC": true,
        "avatarURL": "string",
        "createdAt": "2024-12-19T16:02:17.198Z",
        "createdBy": {
          "delete": true,
          "id": 0,
          "meta": {
            "additionalProp": "Unknown Type: any"
          },
          "type": 0
        },
        "deletedAt": "2024-12-19T16:02:17.198Z",
        "deletedBy": {
          "delete": true,
          "id": 0,
          "meta": {
            "additionalProp": "Unknown Type: any"
          },
          "type": 0
        },
        "editMethod": "string",
        "email": "string",
        "filter_args": {
          "aggregate": {
            "Distinct": true,
            "Field": "string",
            "Operation": "string"
          },
          "bulkDryExecute": true,
          "fields": [
            "string"
          ],
          "filter": [
            "string"
          ],
          "id": 0,
          "ids": [
            0
          ],
          "includes": [
            "string"
          ],
          "orderBy": "string",
          "orderMode": "asc",
          "page": 0,
          "pageOffset": 0,
          "pageSize": 0,
          "skipAggregation": true
        },
        "firstName": "string",
        "id": 0,
        "isAppOwner": true,
        "isPartTime": true,
        "lastName": "string",
        "ldKey": "string",
        "onboarding": {
          "addedFirstInbox": true,
          "bookmarkPage": true,
          "checkDeskHelpSite": true,
          "checkSampleInbox": true,
          "dismissedWelcome": true,
          "exploreHelpsites": true,
          "exploreReports": true,
          "inviteTeam": true,
          "repliedToFirstTicket": true,
          "reviewedCompanySettings": true,
          "reviewedProfile": true
        },
        "projectsCompanyId": 0,
        "reviewer": true,
        "role": "string",
        "sendPushNotifications": true,
        "sendWebNotifications": true,
        "state": "string",
        "ticketReplyRedirect": "string",
        "timeFormatId": 0,
        "timezoneId": 0,
        "trainingWheelsEnrollment": {
          "delete": true,
          "id": 0,
          "meta": {
            "additionalProp": "Unknown Type: any"
          },
          "type": 0
        },
        "updatedAt": "2024-12-19T16:02:17.198Z",
        "updatedBy": {
          "delete": true,
          "id": 0,
          "meta": {
            "additionalProp": "Unknown Type: any"
          },
          "type": 0
        }
      }
    ]
  },
  "meta": {
    "page": {
      "count": 0,
      "hasMore": true,
      "hasMorePages": true,
      "page": 0,
      "pageOffset": 0,
      "pageSize": 0,
      "pages": 0,
      "records": 0
    }
  },
  "pagination": {
    "count": 0,
    "hasMore": true,
    "hasMorePages": true,
    "page": 0,
    "pageOffset": 0,
    "pageSize": 0,
    "pages": 0,
    "records": 0
  }
}

Download Swagger