---
updatedAt: 2025-06-05T21:40:10.000Z
agentTools:
  projectIndex: https://apidocs.officient.io/llms.txt
---

# Person custom fields

scope required: personal.info.custom.fields:read

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "officient-api",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.officient.io"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "oauth2",
        "flows": {}
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/1.0/people/{person_id}/custom_fields": {
      "get": {
        "summary": "Person custom fields",
        "description": "",
        "operationId": "person-custom-fields",
        "parameters": [
          {
            "name": "person_id",
            "in": "path",
            "schema": {
              "type": "integer",
              "format": "int32"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"data\": [\n        {\n            \"custom_field_id\": 157,\n            \"custom_field_name\": \"Allergies\",\n            \"type\": \"string\",\n            \"value\": \"peanuts\",\n            \"value_name\": null\n        },\n        {\n            \"custom_field_id\": 158,\n            \"custom_field_name\": \"is right handed\",\n            \"type\": \"select_option\",\n            \"value\": \"215\",\n            \"value_name\": \"yes\"\n        }\n    ]\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "custom_field_id": {
                            "type": "integer",
                            "example": 157,
                            "default": 0
                          },
                          "custom_field_name": {
                            "type": "string",
                            "example": "Allergies"
                          },
                          "type": {
                            "type": "string",
                            "example": "string"
                          },
                          "value": {
                            "type": "string",
                            "example": "peanuts"
                          },
                          "value_name": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"status_code\": 400,\n    \"reason_phrase\": \"Employee not found or you have no access.\"\n}"
                  }
                },
                "schema": {
                  "oneOf": [
                    {
                      "type": "object",
                      "properties": {
                        "status_code": {
                          "type": "integer",
                          "example": 400,
                          "default": 0
                        },
                        "reason_phrase": {
                          "type": "string",
                          "example": "Invalid employee id"
                        }
                      }
                    },
                    {
                      "type": "object",
                      "properties": {
                        "status_code": {
                          "type": "integer",
                          "example": 400,
                          "default": 0
                        },
                        "reason_phrase": {
                          "type": "string",
                          "example": "Employee not found or you have no access."
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": false,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```