---
title: "Get Custom Fields (Account)"
method: GET
path: "/customfields"
tags: ["Custom Fields"]
---

# Get Custom Fields (Account)

`GET /customfields`

Returns a list of custom fields in current account.

<b>Scopes:</b> Default, wsReadOnly, wsReadWrite

## Query parameters

- `title` string — Custom field title

## Response `2XX`

success response

- object
  - `data` CustomFieldDescription[]
    - `settings` CustomFieldSettings
      - `optionColorsEnabled` boolean — Is colors for options enabled (only for DropDown and MultipleSelect type). Use parameter 'options' to specify colors
      - `linkToDatabaseInfo` CustomFieldLinkToDatabaseField
        - `allowMultipleEntries` boolean, required — Allow linkage of multiple records
        - `dataHubDatabaseId` string, required — DataHub database identifier in DataHub Public API format
        - `mirrorFields` CustomFieldLinkToDatabaseMirrorField[] — Mirror fields associated with this link
          - `dataHubFieldId` string, required — DataHub field identifier in DataHub Public API format
          - `customFieldId` string, required — Custom field id of this mirror
      - `timezone` string — Timezone Id, e.g 'America/New_York' (only for Date type)
      - `values` string[] — Dropdown values without colors (only for DropDown and MultipleSelect type)
      - `aggregation` 'Average' | 'Sum' | 'None' — * `Average` * `Sum` * `None`
      - `readOnly` boolean, required — Is field value read only
      - `allowOtherValues` boolean — Allow users to input other values (only for DropDown type)
      - `useThousandsSeparator` boolean — Use thousands separator (only for Numeric type)
      - `decimalPlaces` number — Decimal places (only for Numeric, Percentage and Currency types)
      - `options` CustomFieldDropdownOption[] — Dropdown options with colors (only for DropDown and MultipleSelect type). Array of objects: {"value": "string", "color": "enum: Brown, Red, Purple, Indigo, DarkBlue, Blue, Turquoise, DarkCyan, Green, YellowGreen, Yellow, Orange, Gray, DarkRed"}
        - `color` 'Brown' | 'DarkCyan' | 'Gray' | 'Blue' | 'DarkBlue' | 'Orange' | 'Red' | 'YellowGreen' | 'Purple' | 'Yellow' | 'Indigo' | 'Turquoise' | 'DarkRed' | 'Green' — * `Brown` - #795548 * `DarkCyan` - #009688 * `Gray` - #9E9E9E * `Blue` - #2196F3 * `DarkBlue` - #3F51B5 * `Orange` - #FF9800 * `Red` - #E91E63 * `YellowGreen` - #CDDC39 * `Purple` - #9C27B0 * `Yellow` - #FFEB3B * `Indigo` - #673AB7 * `Turquoise` - #00BCD4 * `DarkRed` - #F44336 * `Green` - #8BC34A
        - `value` string, required — value
      - `currency` 'CHF' | 'ARS' | 'MXN' | 'QAR' | 'SAR' | 'CLP' | 'ZAR' | 'INR' | 'VND' | 'THB' | 'CNY' | 'AUD' | 'ILS' | 'KRW' | 'JPY' | 'PLN' | 'GBP' | 'IDR' | 'HUF' | 'AMD' | 'PHP' | 'BYR' | 'TRY' | 'BWP' | 'RUB' | 'AED' | 'HKD' | 'TWD' | 'EUR' | 'COP' | 'DKK' | 'USD' | 'CAD' | 'MYR' | 'NOK' | 'RON' | 'SGD' | 'CZK' | 'AZN' | 'PEN' | 'SEK' | 'NZD' | 'BRL' | 'UAH' — * `CHF` * `ARS` * `MXN` * `QAR` * `SAR` * `CLP` * `ZAR` * `INR` * `VND` * `THB` * `CNY` * `AUD` * `ILS` * `KRW` * `JPY` * `PLN` * `GBP` * `IDR` * `HUF` * `AMD` * `PHP` * `BYR` * `TRY` * `BWP` * `RUB` * `AED` * `HKD` * `TWD` * `EUR` * `COP` * `DKK` * `USD` * `CAD` * `MYR` * `NOK` * `RON` * `SGD` * `CZK` * `AZN` * `PEN` * `SEK` * `NZD` * `BRL` * `UAH`
      - `allowTime` boolean — Allow users to input time (only for Date type)
      - `mirrorInfo` CustomFieldMirrorField
        - `dataHubFieldId` string, required — DataHub field identifier in DataHub Public API format
        - `linkToDatabaseCustomFieldId` string, required — Link to Database custom field id of this mirror
      - `applicableEntityTypes` CustomFieldApplicableEntityType[] — Applicable entity types
      - `contacts` UserId[] — Allowed users or invitations (only for Users type)
      - `inheritanceType` 'All' | 'Projects' | 'Folders'
    - `archivedOn` string — Date when the custom field was archived, formatted as ISO local date<br>Format: yyyy-MM-dd'T'HH:mm:ss'Z'
    - `sharedIds` UserId[] — Users with whom the custom field is shared. Field is obsolete, use 'sharing' to get more relevant access settings
    - `description` string — Custom field description
    - `title` string — Custom field title
    - `type` 'Multiple' | 'Percentage' | 'Text' | 'Duration' | 'CalculatedNumeric' | 'Date' | 'CalculatedDate' | 'Numeric' | 'Contacts' | 'Checkbox' | 'Currency' | 'DropDown' | 'LinkToDatabase' — * `Multiple` - Collection field * `Percentage` - Comparable field * `Text` - String field, Comparable field * `Duration` - Comparable field * `CalculatedNumeric` - Calculated comparable field * `Date` - Comparable field * `CalculatedDate` - Calculated comparable field * `Numeric` - Comparable field * `Contacts` - Collection field * `Checkbox` - Boolean field * `Currency` - Comparable field * `DropDown` - String field, Comparable field * `LinkToDatabase` - Link to database field
    - `sharing` CustomFieldSharing
      - `readerIds` UserId[] — Users who can see the field.<br> <ul> <li>null – everyone can read values</li> <li>empty – available for space custom fields only. When readerIds is empty, spaceReaders must be non-null. It means that read access is granted only via space membership (spaceReaders)</li> </ul>
      - `spaceReaders` 'Admin' | 'Member' — * `Admin` - Grant access to space admins only * `Member` - Grant access to all space members
      - `spaceWriters` 'Admin' | 'Member' — * `Admin` - Grant access to space admins only * `Member` - Grant access to all space members
      - `writerIds` UserId[] — Users who can edit field values.<br> <ul> <li>null – everyone can edit values. Allowed only when readerIds == null</li> <li>empty – if spaceWriters is null, then nobody can edit values. Otherwise, write access is granted only via space membership (spaceWriters)</li> </ul> <br> Various system actions (request form submission, automation action...) are not affected by this setting
    - `dataUsageStatistics` DataUsageStatistics
      - `spaceDataPoints` object, required — Map<String, Datapoint> - Space data points
      - `accountDataPoints` Datapoint
        - `lastUsedOn` string — Last used on<br>Format: yyyy-MM-dd'T'HH:mm:ss'Z'
        - `timesUsedThisMonth` number, required — Number of times used this month
        - `timesUsedTotal` number, required — Total number of times used
        - `lastUsedBy` string
    - `accountId` string
    - `spaceId` string
    - `archived` boolean — Whether the custom field is archived
    - `id` string
    - `archivedBy` string — User ID
  - `kind` 'accounts' | 'users' | 'contacts' | 'assets' | 'eDiscoveryReport' | 'folders' | 'folderTree' | 'tasks' | 'taskIds' | 'timelogs' | 'timelogCategories' | 'timelogLockPeriods' | 'timetrackerTimers' | 'comments' | 'attachments' | 'url' | 'version' | 'dataExport' | 'dataExportSchema' | 'auditLog' | 'accessRoles' | 'stream' | 'changes' | 'posts' | 'mailSettings' | 'integrationInfo' | 'gmailIntegrationSettings' | 'workTypesForIntegrations' | 'ids' | 'backups' | 'domains' | 'dependencies' | 'workflows' | 'workschedules' | 'workscheduleExclusions' | 'workscheduleUserExclusions' | 'customfields' | 'customfieldIds' | 'customstatuses' | 'invitations' | 'notifications' | 'jobroles' | 'placeholders' | 'groups' | 'session' | 'dashboards' | 'widgets' | 'taskCreationSettings' | 'colors' | 'experiments' | 'topics' | 'topicComments' | 'webhooks' | 'reviews' | 'boards' | 'textSearch' | 'chatChannels' | 'chatMessages' | 'forms' | 'requestForms' | 'request' | 'report' | 'platformWidgets' | 'platformWidgetInstances' | 'spaces' | 'pdf' | 'customerSatisfaction' | 'asyncJob' | 'approvals' | 'highlights' | 'highlightsList' | 'highlightsSettings' | 'highlightsCard' | 'timesheet' | 'timesheetRow' | 'timesheetSubmissionRule' | 'mobileFeatures' | 'mobileSettings' | 'folderBlueprintTree' | 'taskBlueprintTree' | 'feedback' | 'timeline_snapshot' | 'contactIds' | 'bookings' | 'integrateThreshold' | 'hourlyRatesProvision' | 'hourlyRates' | 'projectTeamMembers' | 'contactsHistory' | 'tasksHistory' | 'foldersHistory' | 'activityDigest' | 'workItemTemplates' | 'workTemplates' | 'workItemMetadata' | 'workItem' | 'customItemTypes' | 'verificationCode' | 'views' | 'listView' | 'tableView' | 'userTypes' | 'reactions' | 'externalRequesters' | 'workscheduleCapacityOverrides' | 'userCapacityOverrides' | 'userCapacityExclusions' | 'rollups' | 'requestFormPrefill' | 'userAggregatedCapacity' | 'cascadingFieldSettings'

## Other responses

- `4XX` — client-side error response
- `5XX` — server-side error response

---

[API](https://skmtc.net/wrike/apis/wrike-api.md) · [All operations](https://skmtc.net/wrike/apis/wrike-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wrike/wrike-api/revisions/f1c1279c29d6/schema)