---
updatedAt: 2025-09-08T20:17:52.000Z
agentTools:
  projectIndex: https://platform.humanity.com/llms.txt
---

# GET Custom Fields

/customfields
Permission level: 7

Retrieves all custom field (id, name, type, access and values).

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "default",
    "version": "2.0"
  },
  "servers": [
    {
      "url": "https://www.humanity.com/api/v2"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "x-default": "",
        "type": "apiKey",
        "name": "access_token",
        "in": "query"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/customfields": {
      "get": {
        "summary": "GET Custom Fields",
        "description": "/customfields\nPermission level: 7",
        "operationId": "get-custom-fields",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"status\": 1,\n  \"data\": [\n    {\n      \"id\": \"1039\",\n      \"name\": \"skype\",\n      \"type\": \"1\",\n      \"access\": \"1\",\n      \"values\": \"\"\n    },\n    {\n      \"id\": \"1040\",\n      \"name\": \"livechatid\",\n      \"type\": \"1\",\n      \"access\": \"3\",\n      \"values\": \"\"\n    },\n    {\n      \"id\": \"1041\",\n      \"name\": \"phone_ext\",\n      \"type\": \"1\",\n      \"access\": \"1\",\n      \"values\": \"\"\n    }\n  ],\n  \"token\": \"xxxx\",\n  \"error\": null\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "integer",
                      "example": 1,
                      "default": 0
                    },
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "example": "1039"
                          },
                          "name": {
                            "type": "string",
                            "example": "skype"
                          },
                          "type": {
                            "type": "string",
                            "example": "1"
                          },
                          "access": {
                            "type": "string",
                            "example": "1"
                          },
                          "values": {
                            "type": "string",
                            "example": ""
                          }
                        }
                      }
                    },
                    "token": {
                      "type": "string",
                      "example": "xxxx"
                    },
                    "error": {}
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false,
        "x-readme": {
          "code-samples": [
            {
              "language": "http",
              "code": "https://www.humanity.com/api/v2/customfields?access_token=xxxxxxx"
            }
          ],
          "samples-languages": [
            "http"
          ]
        }
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```