Get a custom field by id.
This returns all details about an individual custom field.
Path Params
- Name
customFieldId
- Type
- integer
- required
- Description
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
Response contains information about a specific customfield.
- Code
- 400
- Type
- object
- Schema
- Description
- 400 Bad Request
ErrorResponse defines how []Error should be marshaled to JSON.
- Code
- 404
- Description
- 404 Not Found No Data
200 OK
{
"count": 0,
"customfield": {
"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"
]
}
}