Get all custom fields
Return all custom fields for the provided filters.
Query Params
- Name
searchTerm
- Type
- string
- Description
filter by custom field name
- Name
projectStatuses
- Type
- string
- Description
filter by project statuses
- Name
orderMode
- Type
- string
- Description
order mode
- Default
asc
- Allowed values
asc
desc
- Name
orderBy
- Type
- string
- Description
order by
- Default
name
- Allowed values
name
project
dateCreated
dateUpdated
- Name
name
- Type
- string
- Description
filter by name
- Name
projectId
- Type
- integer
- Description
filter by project id
- Name
pageSize
- Type
- integer
- Description
number of items in a page
- Default
50
- Name
page
- Type
- integer
- Description
page number
- Default
1
- Name
useFormulaFields
- Type
- boolean
- Description
use formula fields
- Name
skipCounts
- Type
- boolean
- Description
SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.
- Name
showDeleted
- Type
- boolean
- Description
include deleted items
- Default
false
- Name
onlyStarredProjects
- Type
- boolean
- Description
filter by starred projects only
- Name
onlySiteLevel
- Type
- boolean
- Description
only return site-level custom fields
- Default
false
- Name
onlyProjectLevel
- Type
- boolean
- Description
only return custom fields for project-level in the response
- Default
false
- Name
matchAllProjectTags
- Type
- boolean
- Description
match all project tags
- Name
includeSiteLevel
- Type
- boolean
- Description
include custom fields for site-level in the response
- Default
true
- Name
projectTagIds
- Type
- array[integer]
- Description
filter by project tag ids
- Format
- Comma separated values
- Name
projectOwnerIds
- Type
- array[integer]
- Description
filter by project owner ids
- Format
- Comma separated values
- Name
projectIds
- Type
- array[integer]
- Description
filter by project ids
- Format
- Comma separated values
- Name
projectHealths
- Type
- array[integer]
- Description
filter by project healths
0: not set 1: bad 2: ok 3: good
- Format
- Comma separated values
- Allowed values
0
1
2
3
- Name
projectCompanyIds
- Type
- array[integer]
- Description
filter by company ids
- Format
- Comma separated values
- Name
projectCategoryIds
- Type
- array[integer]
- Description
filter by project category ids
- Format
- Comma separated values
- Name
include
- Type
- array[string]
- Description
include
- Format
- Comma separated values
- Allowed values
projects
createdBy
updatedBy
deletedBy
- Name
ids
- Type
- array[integer]
- Description
filter by custom field ids
- Format
- Comma separated values
- Name
fields[users]
- Type
- array[string]
- Description
- Format
- Comma separated values
- Allowed values
id
firstName
lastName
title
email
companyId
company
isAdmin
isClientUser
isServiceAccount
type
deleted
avatarUrl
lengthOfDay
workingHoursId
workingHour
userRate
userCost
canAddProjects
- Name
fields[projects]
- Type
- array[string]
- Description
- Format
- Comma separated values
- Allowed values
id
name
- Name
entities
- Type
- array[string]
- Description
filter by entities
- Format
- Comma separated values
Responses
- Code
- 200
- Type
- object
- Schema
- Description
- 200 OK
CustomFieldsResponse contains information about a group of custom fields.
- Code
- 400
- Type
- object
- Schema
- Description
- 400 Bad Request
ErrorResponse defines how []Error should be marshaled to JSON.
200 OK
{
"customfields": [
{
"createdAt": "string",
"createdBy": 0,
"createdByUserId": 0,
"currencyCode": "string",
"deleted": true,
"deletedAt": "string",
"deletedBy": 0,
"deletedByUserId": 0,
"description": "string",
"entity": "string",
"formula": "string",
"groupId": 0,
"id": 0,
"isPrivate": true,
"name": "string",
"project": {
"id": 0,
"meta": {},
"type": "string"
},
"projectId": 0,
"required": true,
"type": "string",
"unitId": 0,
"updatedAt": "string",
"updatedBy": 0,
"updatedByUserId": 0,
"visibilities": [
"string"
]
}
],
"included": {
"projects": {
"additionalProp": {
"activePages": {
"billing": true,
"board": true,
"comments": true,
"files": true,
"finance": true,
"forms": true,
"gantt": true,
"links": true,
"list": true,
"messages": true,
"milestones": true,
"notebooks": true,
"proofs": true,
"riskRegister": true,
"table": true,
"tasks": true,
"tickets": true,
"time": true
},
"allowNotifyAnyone": true,
"announcement": "string",
"category": {
"id": 0,
"meta": {},
"type": "string"
},
"categoryId": 0,
"company": {
"id": 0,
"meta": {},
"type": "string"
},
"companyId": 0,
"createdAt": "string",
"createdBy": 0,
"customFieldValueIds": [
0
],
"customFieldValues": [
{
"id": 0,
"meta": {},
"type": "string"
}
],
"customfieldValues": [
{
"id": 0,
"meta": {},
"type": "string"
}
],
"defaultPrivacy": "string",
"description": "string",
"directFileUploadsEnabled": true,
"endAt": "string",
"endDate": "string",
"financialBudget": {
"id": 0,
"meta": {},
"type": "string"
},
"financialBudgetId": 0,
"harvestTimersEnabled": true,
"id": 0,
"integrations": {
"googleDrive": {
"access": "string",
"enabled": true,
"folder": "string",
"folderName": "string"
},
"oneDriveBusiness": {
"account": "string",
"enabled": true,
"folder": "string",
"folderName": "string"
},
"sharepoint": {
"account": "string",
"enabled": true,
"folder": "string",
"folderName": "string"
},
"xero": {
"baseCurrency": "string",
"connected": true,
"countryCode": "string",
"enabled": true,
"organisation": "string"
}
},
"isBillable": true,
"isOnBoardingProject": true,
"isProjectAdmin": true,
"isSampleProject": true,
"isStarred": true,
"lastWorkedOn": "string",
"latestActivity": {
"id": 0,
"meta": {},
"type": "string"
},
"logo": "string",
"logoColor": "string",
"logoIcon": "string",
"minMaxAvailableDates": {
"deadlinesFound": true,
"maxEndDate": "string",
"minStartDate": "string",
"suggestedEndDate": "string",
"suggestedStartDate": "string"
},
"name": "string",
"notifyCommentIncludeCreator": true,
"notifyEveryone": true,
"notifyTaskAssignee": true,
"overviewStartPage": "string",
"ownedBy": 0,
"ownerId": 0,
"portfolioCards": [
{
"id": 0,
"meta": {},
"type": "string"
}
],
"privacyEnabled": true,
"projectOwner": {
"id": 0,
"meta": {},
"type": "string"
},
"projectOwnerId": 0,
"replyByEmailEnabled": true,
"showAnnouncement": true,
"skipWeekends": true,
"startAt": "string",
"startDate": "string",
"startPage": "string",
"status": "string",
"subStatus": "string",
"tagIds": [
0
],
"tags": [
{
"id": 0,
"meta": {},
"type": "string"
}
],
"tasksStartPage": "string",
"timeBudget": {
"id": 0,
"meta": {},
"type": "string"
},
"timeBudgetId": 0,
"type": "string",
"update": {
"id": 0,
"meta": {},
"type": "string"
},
"updateId": 0,
"updatedAt": "string",
"updatedBy": 0,
"users": [
{
"id": 0,
"meta": {},
"type": "string"
}
],
"workflows": [
{
"id": 0,
"meta": {},
"type": "string"
}
]
}
},
"users": {
"additionalProp": {
"avatarUrl": "string",
"canAddProjects": true,
"company": {
"id": 0,
"meta": {},
"type": "string"
},
"companyId": 0,
"companyRoleId": 0,
"deleted": true,
"email": "string",
"firstName": "string",
"id": 0,
"isAdmin": true,
"isClientUser": true,
"isServiceAccount": true,
"jobRoles": [
{
"id": 0,
"meta": {},
"type": "string"
}
],
"lastName": "string",
"lengthOfDay": 0,
"meta": {},
"teams": [
{
"id": 0,
"meta": {},
"type": "string"
}
],
"timezone": "string",
"title": "string",
"type": "string",
"userCost": 0,
"userRate": 0,
"workingHour": {
"id": 0,
"meta": {},
"type": "string"
},
"workingHoursId": 0
}
}
},
"meta": {
"averageSpend": 0,
"limit": 0,
"nextCursor": "string",
"page": {
"count": 0,
"hasMore": true,
"pageOffset": 0,
"pageSize": 0
},
"prevCursor": "string",
"totalCapacity": 0
}
}