---
title: "Get Team Custom Field"
method: POST
path: "/team-custom-field/{id}/get-item"
tags: ["Team Custom Field"]
---

# Get Team Custom Field

`POST /team-custom-field/{id}/get-item`

## Request

- Base URL: `https://oneuptime.com/api`
- URL: `https://oneuptime.com/api/team-custom-field/{id}/get-item`
- Auth: API key in header `APIKey`
- TypeScript: <https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/docs/team-custom-field/:id/get-item/post.ts> (a function with typed inputs; its response is checked against the schema)

Endpoint to retrieve a single Team Custom Field by ID

## Path parameters

- `id` string, uuid, required

## Request body

- object
  - `select` TeamCustomFieldSelectSchema: Select schema for TeamCustomField. Set fields to true to include them in the response.
    - `_id` boolean
    - `createdAt` boolean
    - `updatedAt` boolean
    - `deletedAt` boolean
    - `projectId` boolean
    - `name` boolean
    - `description` boolean
    - `customFieldType` boolean
    - `dropdownOptions` boolean
    - `mapFromResourceType` boolean
    - `mapFromCustomFieldName` boolean
    - `createdByUserId` boolean
    - `deletedByUserId` boolean

## Response `200`

Successful response

- object
  - `data` TeamCustomField
    - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Create Team Custom Field], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Team Custom Field], Update: [Project Owner, Project Admin, Edit Team Custom Field]
    - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Create Team Custom Field], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Team Custom Field], Update: [Project Owner, Project Admin, Edit Team Custom Field]
    - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Create Team Custom Field], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Team Custom Field], Update: [Project Owner, Project Admin, Edit Team Custom Field]
    - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Create Team Custom Field], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Team Custom Field], Update: [Project Owner, Project Admin, Edit Team Custom Field]
    - `version` number: Object version
    - `projectId` string, uuid, required: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Create Team Custom Field], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Team Custom Field], Update: [No access - you don't have permission for this operation]
    - `name` string, required: Any friendly name of this object. Permissions - Create: [Project Owner, Project Admin, Create Team Custom Field], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Team Custom Field], Update: [Project Owner, Project Admin, Edit Team Custom Field]
    - `description` string: Friendly description of this custom field that will help you remember. Permissions - Create: [Project Owner, Project Admin, Create Team Custom Field], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Team Custom Field], Update: [Project Owner, Project Admin, Edit Team Custom Field]
    - `customFieldType` 'Text' | 'Number' | 'Boolean' | 'Dropdown' | 'MultiSelectDropdown' | 'Date' | 'DateTime' | 'LongText' | 'Markdown' | 'File' | 'MultipleFiles': What kind of value the field holds, such as Text, Number or Dropdown. Permissions - Create: [Project Owner, Project Admin, Create Team Custom Field], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Team Custom Field], Update: [No access - you don't have permission for this operation]
    - `dropdownOptions` string: Options and optional colors for dropdown fields, in the order they are listed. Plain one-per-line values remain supported. Records store an option as its text: changing an option here keeps the values records already hold. To rename an option and move those values with it, send the renames with the update, in miscDataProps: {"renamedDropdownOptions": [{"from": "Old text", "to": "New text"}]}. "to" must be one of the options. Permissions - Create: [Project Owner, Project Admin, Create Team Custom Field], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Team Custom Field], Update: [Project Owner, Project Admin, Edit Team Custom Field]
    - `mapFromResourceType` 'Monitor': Related resource this field copies its value from. Empty means values are entered by hand. Permissions - Create: [Project Owner, Project Admin, Create Team Custom Field], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Team Custom Field], Update: [Project Owner, Project Admin, Edit Team Custom Field]
    - `mapFromCustomFieldName` string: Name of the custom field on the related resource this field copies its value from. Permissions - Create: [Project Owner, Project Admin, Create Team Custom Field], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Team Custom Field], Update: [Project Owner, Project Admin, Edit Team Custom Field]
    - `createdByUserId` string, uuid: User ID who created this object (if this object was created by a User). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Team Custom Field], Update: [No access - you don't have permission for this operation]
    - `deletedByUserId` string, uuid: User ID who deleted this object (if this object was deleted by a User). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Team Custom Field], Update: [No access - you don't have permission for this operation]

## Other responses

- `400`: Bad request. This response indicates that the request was malformed or contained invalid data.
- `401`: Unauthorized. This response indicates that the request requires user authentication.
- `402`: Payment Required. This response indicates that the request requires payment or a valid subscription.
- `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it.
- `404`: Not found. The record does not exist, belongs to another project, or is one you may not read - the same answer for each.
- `405`: Project not found. This response indicates that the requested project does not exist or is not accessible.
- `408`: Request Timeout. This response indicates that the server timed out waiting for the request.
- `415`: Unable to reach server. This response indicates that the server is currently unreachable or down.
- `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource.
- `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

---

[API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)