---
title: "Get the default site"
method: GET
path: "/api/v1/site/defaultSite"
tags: ["Site"]
---

# Get the default site

`GET /api/v1/site/defaultSite`

Returns the site marked as the default site in the system.

## Response `200`

Default site retrieved successfully

- ResponseEntityHostView
  - `errors` ErrorEntity[]
    - `errorCode` string
    - `message` string
    - `fieldName` string
  - `entity` Host
    - `lowIndexPriority` boolean
    - `variantId` string
    - `systemHost` boolean
    - `hostThumbnail` string, binary
    - `structureInode` string
    - `inode` string
    - `parent` boolean
    - `tagStorage` string
    - `hostname` string
    - `aliases` string
    - `default` boolean
    - `name` string
    - `permissionId` string
    - `permissionType` string
    - `owner` string
    - `modDate` string, date-time
    - `identifier` string
    - `type` string
    - `userAPI` UserAPI
      - `defaultUser` User
        - `modificationDate` string, date-time
        - `actualCompanyId` string
        - `passwordExpired` boolean
        - `recipientAddress` string
        - `recipientInternetAddress` string
        - `multipleRecipients` boolean
        - `female` boolean
        - `recipientId` string
        - `timeZoneId` string
        - `anonymousUser` boolean
        - `companyId` string
        - `resolution` string
        - `refreshRate` string
        - `defaultUser` boolean
        - `recipientName` string
        - `userRole` Role
          - `id` string
          - `name` string
          - `description` string
          - `roleKey` string
          - `parent` string
          - `editPermissions` boolean
          - `editUsers` boolean
          - `editLayouts` boolean
          - `locked` boolean
          - `system` boolean
          - `roleChildren` string[]
          - `fqn` string
          - `dbfqn` string
          - `user` boolean
        - `languageId` string
        - `fullName` string
        - `locale` object
          - `script` string
          - `variant` string
          - `unicodeLocaleAttributes` string[]
          - `unicodeLocaleKeys` string[]
          - `displayLanguage` string
          - `displayScript` string
          - `displayCountry` string
          - `displayVariant` string
          - `displayName` string
          - `country` string
          - `extensionKeys` string[]
          - `iso3Language` string
          - `iso3Country` string
          - `language` string
        - `timeZone` object
          - `dstsavings` integer
          - `rawOffset` integer
          - `id` string
          - `displayName` string
        - `passwordExpirationDate` string, date-time
        - `failedLoginAttempts` integer
        - `agreedToTermsOfUse` boolean
        - `deleteInProgress` boolean
        - `passwordEncrypted` boolean
        - `favoriteActivity` string
        - `favoriteBibleVerse` string
        - `lastLoginIP` string
        - `deleteDate` string, date-time
        - `passwordReset` boolean
        - `smsId` string
        - `aimId` string
        - `icqId` string
        - `msnId` string
        - `ymId` string
        - `favoriteFood` string
        - `favoriteMovie` string
        - `favoriteMusic` string
        - `dottedSkins` boolean
        - `roundedSkins` boolean
        - `greeting` string
        - `loginDate` string, date-time
        - `loginIP` string
        - `layoutIds` string
        - `comments` string
        - `additionalInfo` object
        - `middleName` string
        - `nickName` string
        - `birthday` string, date-time
        - `firstName` string
        - `lastName` string
        - `male` boolean
        - `createDate` string, date-time
        - `userId` string
        - `skinId` string
        - `lastLoginDate` string, date-time
        - `emailAddress` string
        - `active` boolean
        - `password` string
        - `modified` boolean
        - `new` boolean
      - `anonymousUserNoThrow` User
        - `modificationDate` string, date-time
        - `actualCompanyId` string
        - `passwordExpired` boolean
        - `recipientAddress` string
        - `recipientInternetAddress` string
        - `multipleRecipients` boolean
        - `female` boolean
        - `recipientId` string
        - `timeZoneId` string
        - `anonymousUser` boolean
        - `companyId` string
        - `resolution` string
        - `refreshRate` string
        - `defaultUser` boolean
        - `recipientName` string
        - `userRole` Role
          - `id` string
          - `name` string
          - `description` string
          - `roleKey` string
          - `parent` string
          - `editPermissions` boolean
          - `editUsers` boolean
          - `editLayouts` boolean
          - `locked` boolean
          - `system` boolean
          - `roleChildren` string[]
          - `fqn` string
          - `dbfqn` string
          - `user` boolean
        - `languageId` string
        - `fullName` string
        - `locale` object
          - `script` string
          - `variant` string
          - `unicodeLocaleAttributes` string[]
          - `unicodeLocaleKeys` string[]
          - `displayLanguage` string
          - `displayScript` string
          - `displayCountry` string
          - `displayVariant` string
          - `displayName` string
          - `country` string
          - `extensionKeys` string[]
          - `iso3Language` string
          - `iso3Country` string
          - `language` string
        - `timeZone` object
          - `dstsavings` integer
          - `rawOffset` integer
          - `id` string
          - `displayName` string
        - `passwordExpirationDate` string, date-time
        - `failedLoginAttempts` integer
        - `agreedToTermsOfUse` boolean
        - `deleteInProgress` boolean
        - `passwordEncrypted` boolean
        - `favoriteActivity` string
        - `favoriteBibleVerse` string
        - `lastLoginIP` string
        - `deleteDate` string, date-time
        - `passwordReset` boolean
        - `smsId` string
        - `aimId` string
        - `icqId` string
        - `msnId` string
        - `ymId` string
        - `favoriteFood` string
        - `favoriteMovie` string
        - `favoriteMusic` string
        - `dottedSkins` boolean
        - `roundedSkins` boolean
        - `greeting` string
        - `loginDate` string, date-time
        - `loginIP` string
        - `layoutIds` string
        - `comments` string
        - `additionalInfo` object
        - `middleName` string
        - `nickName` string
        - `birthday` string, date-time
        - `firstName` string
        - `lastName` string
        - `male` boolean
        - `createDate` string, date-time
        - `userId` string
        - `skinId` string
        - `lastLoginDate` string, date-time
        - `emailAddress` string
        - `active` boolean
        - `password` string
        - `modified` boolean
        - `new` boolean
      - `systemUser` User
        - `modificationDate` string, date-time
        - `actualCompanyId` string
        - `passwordExpired` boolean
        - `recipientAddress` string
        - `recipientInternetAddress` string
        - `multipleRecipients` boolean
        - `female` boolean
        - `recipientId` string
        - `timeZoneId` string
        - `anonymousUser` boolean
        - `companyId` string
        - `resolution` string
        - `refreshRate` string
        - `defaultUser` boolean
        - `recipientName` string
        - `userRole` Role
          - `id` string
          - `name` string
          - `description` string
          - `roleKey` string
          - `parent` string
          - `editPermissions` boolean
          - `editUsers` boolean
          - `editLayouts` boolean
          - `locked` boolean
          - `system` boolean
          - `roleChildren` string[]
          - `fqn` string
          - `dbfqn` string
          - `user` boolean
        - `languageId` string
        - `fullName` string
        - `locale` object
          - `script` string
          - `variant` string
          - `unicodeLocaleAttributes` string[]
          - `unicodeLocaleKeys` string[]
          - `displayLanguage` string
          - `displayScript` string
          - `displayCountry` string
          - `displayVariant` string
          - `displayName` string
          - `country` string
          - `extensionKeys` string[]
          - `iso3Language` string
          - `iso3Country` string
          - `language` string
        - `timeZone` object
          - `dstsavings` integer
          - `rawOffset` integer
          - `id` string
          - `displayName` string
        - `passwordExpirationDate` string, date-time
        - `failedLoginAttempts` integer
        - `agreedToTermsOfUse` boolean
        - `deleteInProgress` boolean
        - `passwordEncrypted` boolean
        - `favoriteActivity` string
        - `favoriteBibleVerse` string
        - `lastLoginIP` string
        - `deleteDate` string, date-time
        - `passwordReset` boolean
        - `smsId` string
        - `aimId` string
        - `icqId` string
        - `msnId` string
        - `ymId` string
        - `favoriteFood` string
        - `favoriteMovie` string
        - `favoriteMusic` string
        - `dottedSkins` boolean
        - `roundedSkins` boolean
        - `greeting` string
        - `loginDate` string, date-time
        - `loginIP` string
        - `layoutIds` string
        - `comments` string
        - `additionalInfo` object
        - `middleName` string
        - `nickName` string
        - `birthday` string, date-time
        - `firstName` string
        - `lastName` string
        - `male` boolean
        - `createDate` string, date-time
        - `userId` string
        - `skinId` string
        - `lastLoginDate` string, date-time
        - `emailAddress` string
        - `active` boolean
        - `password` string
        - `modified` boolean
        - `new` boolean
      - `anonymousUser` User
        - `modificationDate` string, date-time
        - `actualCompanyId` string
        - `passwordExpired` boolean
        - `recipientAddress` string
        - `recipientInternetAddress` string
        - `multipleRecipients` boolean
        - `female` boolean
        - `recipientId` string
        - `timeZoneId` string
        - `anonymousUser` boolean
        - `companyId` string
        - `resolution` string
        - `refreshRate` string
        - `defaultUser` boolean
        - `recipientName` string
        - `userRole` Role
          - `id` string
          - `name` string
          - `description` string
          - `roleKey` string
          - `parent` string
          - `editPermissions` boolean
          - `editUsers` boolean
          - `editLayouts` boolean
          - `locked` boolean
          - `system` boolean
          - `roleChildren` string[]
          - `fqn` string
          - `dbfqn` string
          - `user` boolean
        - `languageId` string
        - `fullName` string
        - `locale` object
          - `script` string
          - `variant` string
          - `unicodeLocaleAttributes` string[]
          - `unicodeLocaleKeys` string[]
          - `displayLanguage` string
          - `displayScript` string
          - `displayCountry` string
          - `displayVariant` string
          - `displayName` string
          - `country` string
          - `extensionKeys` string[]
          - `iso3Language` string
          - `iso3Country` string
          - `language` string
        - `timeZone` object
          - `dstsavings` integer
          - `rawOffset` integer
          - `id` string
          - `displayName` string
        - `passwordExpirationDate` string, date-time
        - `failedLoginAttempts` integer
        - `agreedToTermsOfUse` boolean
        - `deleteInProgress` boolean
        - `passwordEncrypted` boolean
        - `favoriteActivity` string
        - `favoriteBibleVerse` string
        - `lastLoginIP` string
        - `deleteDate` string, date-time
        - `passwordReset` boolean
        - `smsId` string
        - `aimId` string
        - `icqId` string
        - `msnId` string
        - `ymId` string
        - `favoriteFood` string
        - `favoriteMovie` string
        - `favoriteMusic` string
        - `dottedSkins` boolean
        - `roundedSkins` boolean
        - `greeting` string
        - `loginDate` string, date-time
        - `loginIP` string
        - `layoutIds` string
        - `comments` string
        - `additionalInfo` object
        - `middleName` string
        - `nickName` string
        - `birthday` string, date-time
        - `firstName` string
        - `lastName` string
        - `male` boolean
        - `createDate` string, date-time
        - `userId` string
        - `skinId` string
        - `lastLoginDate` string, date-time
        - `emailAddress` string
        - `active` boolean
        - `password` string
        - `modified` boolean
        - `new` boolean
      - `unDeletedUsers` User[]
        - `modificationDate` string, date-time
        - `actualCompanyId` string
        - `passwordExpired` boolean
        - `recipientAddress` string
        - `recipientInternetAddress` string
        - `multipleRecipients` boolean
        - `female` boolean
        - `recipientId` string
        - `timeZoneId` string
        - `anonymousUser` boolean
        - `companyId` string
        - `resolution` string
        - `refreshRate` string
        - `defaultUser` boolean
        - `recipientName` string
        - `userRole` Role
          - `id` string
          - `name` string
          - `description` string
          - `roleKey` string
          - `parent` string
          - `editPermissions` boolean
          - `editUsers` boolean
          - `editLayouts` boolean
          - `locked` boolean
          - `system` boolean
          - `roleChildren` string[]
          - `fqn` string
          - `dbfqn` string
          - `user` boolean
        - `languageId` string
        - `fullName` string
        - `locale` object
          - `script` string
          - `variant` string
          - `unicodeLocaleAttributes` string[]
          - `unicodeLocaleKeys` string[]
          - `displayLanguage` string
          - `displayScript` string
          - `displayCountry` string
          - `displayVariant` string
          - `displayName` string
          - `country` string
          - `extensionKeys` string[]
          - `iso3Language` string
          - `iso3Country` string
          - `language` string
        - `timeZone` object
          - `dstsavings` integer
          - `rawOffset` integer
          - `id` string
          - `displayName` string
        - `passwordExpirationDate` string, date-time
        - `failedLoginAttempts` integer
        - `agreedToTermsOfUse` boolean
        - `deleteInProgress` boolean
        - `passwordEncrypted` boolean
        - `favoriteActivity` string
        - `favoriteBibleVerse` string
        - `lastLoginIP` string
        - `deleteDate` string, date-time
        - `passwordReset` boolean
        - `smsId` string
        - `aimId` string
        - `icqId` string
        - `msnId` string
        - `ymId` string
        - `favoriteFood` string
        - `favoriteMovie` string
        - `favoriteMusic` string
        - `dottedSkins` boolean
        - `roundedSkins` boolean
        - `greeting` string
        - `loginDate` string, date-time
        - `loginIP` string
        - `layoutIds` string
        - `comments` string
        - `additionalInfo` object
        - `middleName` string
        - `nickName` string
        - `birthday` string, date-time
        - `firstName` string
        - `lastName` string
        - `male` boolean
        - `createDate` string, date-time
        - `userId` string
        - `skinId` string
        - `lastLoginDate` string, date-time
        - `emailAddress` string
        - `active` boolean
        - `password` string
        - `modified` boolean
        - `new` boolean
    - `htmlpage` boolean
    - `vanityUrl` boolean
    - `categoryId` string
    - `versionId` string
    - `working` boolean
    - `modUser` string
    - `contentTypeId` string
    - `host` string
    - `keyValue` boolean
    - `titleImage` Field
      - `fieldContentTypeProperties` string[]
      - `clazz` string, required
    - `folder` string
    - `dotAsset` boolean
    - `persona` boolean
    - `form` boolean
    - `indexPolicyDependencies` 'DEFER' | 'WAIT_FOR' | 'FORCE'
    - `languageVariable` boolean
    - `archived` boolean
    - `languageId` integer
    - `sortOrder` integer
    - `fileAsset` boolean
    - `new` boolean
    - `live` boolean
    - `title` string
    - `locked` boolean
  - `messages` MessageEntity[]
    - `message` string
  - `i18nMessagesMap` object
  - `permissions` string[]
  - `pagination` Pagination
    - `currentPage` integer
    - `perPage` integer
    - `totalEntries` integer

## Other responses

- `403` — User does not have permission to access sites
- `500` — Internal server error

---

[API](https://skmtc.dev/jostens/apis/dotcms-rest-api.md) · [All operations](https://skmtc.dev/jostens/apis/dotcms-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/jostens/dotcms-rest-api/revisions/a088fe9f515c/schema)
