---
title: "Get project field by id"
method: GET
path: "/v0/project_fields/{project_field_id}"
tags: ["Project Fields"]
---

# Get project field by id

`GET /v0/project_fields/{project_field_id}`

## Request

- Base URL: `https://api.gem.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.gem.com/v0/project_fields/{project_field_id}`
- Auth: none declared

Returns a project field with the coresponding id.

## Response `200`

OK

- ProjectFieldResponse
  - `id` string, ObjectID
  - `name` string, required: The name of the project field.
  - `field_type` 'text' | 'single_select' | 'multi_select', required: The type of the project field. Options are `text`, `single_select`, or `multi_select`.
  - `user_id` string, ObjectID, required: The user id of the admin creating the project field.
  - `options` ProjectFieldOptionResponse[]: The options of the project field. Only applicable when `value_type` is one of (`single_select`, `multi_select`).
    - `id` string, ObjectID
    - `value` string
    - `is_hidden` boolean: When `is_hidden` is `true`, field options are not displayed in the Gem product, nor are they returned when making a query on the Projects endpoint.
  - `is_required` boolean
  - `is_hidden` boolean: When `is_hidden` is `true`, project fields are not displayed in the Gem product, nor are they returned when making a query on the Projects endpoint.

## Other responses

- `default`: Default error response

---

[API](https://skmtc.dev/gem/apis/gem-crm-api.md) - [All operations](https://skmtc.dev/gem/apis/gem-crm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gem/apis/gem-crm-api/revisions/50a984e3c2b5?raw)