--- updatedAt: 2026-08-06T21:05:39.000Z agentTools: projectIndex: https://snipe-it.readme.io/llms.txt --- # /fieldsets List all custom fieldsets Please see the documentation on [Custom Fields and Fieldsets](https://snipe-it.readme.io/docs/custom-fields) and [Updating Custom Fields via API](https://snipe-it.readme.io/reference/updating-custom-fields) for more information on how custom fields work. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "snipe-it-rest-api", "version": "8.2.0" }, "servers": [ { "url": "https://develop.snipeitapp.com/api/v1" } ], "security": [ {} ], "paths": { "/fieldsets": { "get": { "summary": "/fieldsets", "description": "List all custom fieldsets", "operationId": "fields", "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"total\": 2,\n \"rows\": [\n {\n \"id\": 1,\n \"name\": \"Mobile Devices\",\n \"fields\": {\n \"total\": 2,\n \"rows\": [\n {\n \"id\": 1,\n \"name\": \"IMEI\",\n \"db_column_name\": \"_snipeit_imei_1\",\n \"format\": \"regex:/^[0-9]{15}$/\",\n \"field_values\": null,\n \"field_values_array\": null,\n \"type\": \"text\",\n \"required\": 0,\n \"created_at\": {\n \"datetime\": \"2020-11-27 21:05:14\",\n \"formatted\": \"Fri Nov 27, 2020 9:05PM\"\n },\n \"updated_at\": {\n \"datetime\": \"2020-11-27 21:05:14\",\n \"formatted\": \"Fri Nov 27, 2020 9:05PM\"\n }\n },\n {\n \"id\": 2,\n \"name\": \"Phone Number\",\n \"db_column_name\": \"_snipeit_phone_number_2\",\n \"format\": \"ANY\",\n \"field_values\": null,\n \"field_values_array\": null,\n \"type\": \"text\",\n \"required\": 0,\n \"created_at\": {\n \"datetime\": \"2020-11-27 21:05:14\",\n \"formatted\": \"Fri Nov 27, 2020 9:05PM\"\n },\n \"updated_at\": {\n \"datetime\": \"2020-11-27 21:05:14\",\n \"formatted\": \"Fri Nov 27, 2020 9:05PM\"\n }\n }\n ]\n },\n \"models\": {\n \"total\": 2,\n \"rows\": [\n {\n \"id\": 15,\n \"name\": \"iPhone 6s\"\n },\n {\n \"id\": 16,\n \"name\": \"iPhone 7\"\n }\n ]\n },\n \"created_at\": {\n \"datetime\": \"2020-11-27 21:05:14\",\n \"formatted\": \"Fri Nov 27, 2020 9:05PM\"\n },\n \"updated_at\": {\n \"datetime\": \"2020-11-27 21:05:14\",\n \"formatted\": \"Fri Nov 27, 2020 9:05PM\"\n }\n },\n {\n \"id\": 2,\n \"name\": \"Laptops and Desktops\",\n \"fields\": {\n \"total\": 3,\n \"rows\": [\n {\n \"id\": 3,\n \"name\": \"RAM\",\n \"db_column_name\": \"_snipeit_ram_3\",\n \"format\": \"ANY\",\n \"field_values\": null,\n \"field_values_array\": null,\n \"type\": \"text\",\n \"required\": 0,\n \"created_at\": {\n \"datetime\": \"2020-11-27 21:05:14\",\n \"formatted\": \"Fri Nov 27, 2020 9:05PM\"\n },\n \"updated_at\": {\n \"datetime\": \"2020-11-27 21:05:14\",\n \"formatted\": \"Fri Nov 27, 2020 9:05PM\"\n }\n },\n {\n \"id\": 4,\n \"name\": \"CPU\",\n \"db_column_name\": \"_snipeit_cpu_4\",\n \"format\": \"ANY\",\n \"field_values\": null,\n \"field_values_array\": null,\n \"type\": \"text\",\n \"required\": 0,\n \"created_at\": {\n \"datetime\": \"2020-11-27 21:05:14\",\n \"formatted\": \"Fri Nov 27, 2020 9:05PM\"\n },\n \"updated_at\": {\n \"datetime\": \"2020-11-27 21:05:14\",\n \"formatted\": \"Fri Nov 27, 2020 9:05PM\"\n }\n },\n {\n \"id\": 5,\n \"name\": \"MAC Address\",\n \"db_column_name\": \"_snipeit_mac_address_5\",\n \"format\": \"regex:/^([0-9a-fA-F]{2}[:-]){5}[0-9a-fA-F]{2}$/\",\n \"field_values\": null,\n \"field_values_array\": null,\n \"type\": \"text\",\n \"required\": 0,\n \"created_at\": {\n \"datetime\": \"2020-11-27 21:05:14\",\n \"formatted\": \"Fri Nov 27, 2020 9:05PM\"\n },\n \"updated_at\": {\n \"datetime\": \"2020-11-27 21:05:14\",\n \"formatted\": \"Fri Nov 27, 2020 9:05PM\"\n }\n }\n ]\n },\n \"models\": {\n \"total\": 10,\n \"rows\": [\n {\n \"id\": 1,\n \"name\": \"Macbook Pro 13"\"\n },\n {\n \"id\": 2,\n \"name\": \"Macbook Air\"\n },\n {\n \"id\": 3,\n \"name\": \"Surface\"\n },\n {\n \"id\": 4,\n \"name\": \"XPS 13\"\n },\n {\n \"id\": 5,\n \"name\": \"Spectre\"\n },\n {\n \"id\": 6,\n \"name\": \"ZenBook UX310\"\n },\n {\n \"id\": 7,\n \"name\": \"Yoga 910\"\n },\n {\n \"id\": 8,\n \"name\": \"iMac Pro\"\n },\n {\n \"id\": 9,\n \"name\": \"Lenovo Intel Core i5\"\n },\n {\n \"id\": 10,\n \"name\": \"OptiPlex\"\n }\n ]\n },\n \"created_at\": {\n \"datetime\": \"2020-11-27 21:05:14\",\n \"formatted\": \"Fri Nov 27, 2020 9:05PM\"\n },\n \"updated_at\": {\n \"datetime\": \"2020-11-27 21:05:14\",\n \"formatted\": \"Fri Nov 27, 2020 9:05PM\"\n }\n }\n ]\n}" } }, "schema": { "type": "object", "properties": { "total": { "type": "integer", "example": 2, "default": 0 }, "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "name": { "type": "string", "example": "Mobile Devices" }, "fields": { "type": "object", "properties": { "total": { "type": "integer", "example": 2, "default": 0 }, "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "name": { "type": "string", "example": "IMEI" }, "db_column_name": { "type": "string", "example": "_snipeit_imei_1" }, "format": { "type": "string", "example": "regex:/^[0-9]{15}$/" }, "field_values": {}, "field_values_array": {}, "type": { "type": "string", "example": "text" }, "required": { "type": "integer", "example": 0, "default": 0 }, "created_at": { "type": "object", "properties": { "datetime": { "type": "string", "example": "2020-11-27 21:05:14" }, "formatted": { "type": "string", "example": "Fri Nov 27, 2020 9:05PM" } } }, "updated_at": { "type": "object", "properties": { "datetime": { "type": "string", "example": "2020-11-27 21:05:14" }, "formatted": { "type": "string", "example": "Fri Nov 27, 2020 9:05PM" } } } } } } } }, "models": { "type": "object", "properties": { "total": { "type": "integer", "example": 2, "default": 0 }, "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 15, "default": 0 }, "name": { "type": "string", "example": "iPhone 6s" } } } } } }, "created_at": { "type": "object", "properties": { "datetime": { "type": "string", "example": "2020-11-27 21:05:14" }, "formatted": { "type": "string", "example": "Fri Nov 27, 2020 9:05PM" } } }, "updated_at": { "type": "object", "properties": { "datetime": { "type": "string", "example": "2020-11-27 21:05:14" }, "formatted": { "type": "string", "example": "Fri Nov 27, 2020 9:05PM" } } } } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } }, "401": { "description": "401", "content": { "text/plain": { "examples": { "Result": { "value": "{\n \"status\": \"error\",\n \"message\": \"Unauthorized.\"\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized." } } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [ { "key": "Authorization", "value": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIyIiwianRpIjoiN2I1OTg3ZGVlYzI0ZmUxNzZmM2M4Y2VmZmFkOWZhZTMwOGY5YTc5MWU5OTI1MjljMWRmMDFmMTFjYThjMWRmZWE5YTlhODdhMDcxOTA2Y2IiLCJpYXQiOjE3ODY2NjIwMzYuMzExNjY1LCJuYmYiOjE3ODY2NjIwMzYuMzExNjcsImV4cCI6MjQxNzgxNDAzNi4yOTc4MDcsInN1YiI6IjEiLCJzY29wZXMiOltdfQ.bsToXzAmDU_c0WfA36bjgIfP9reBXaDrV3vEz78fJ6mdvnGBBPfqRFD3nb2NL6Zr2X3EavWoFA2-Adn3L-0Ds7OFBfU9jdyu5vlaA-f6BHVBuJlGu2NO0SuYmlRG-2DqMQL8MHjM2NQ4k1HX5UV8ox9fzxXAe9nD7wmV0mgWtWAyq29XfiBZQcYWLKjam0LnvHbFnL29ikVazCK6_Kl9_7d0gkX32QdgbtgIFDmrngSHnAeO2wTvUvf-rz8HsV0cv_9SALuLPNSUXiKjC2amSsgzU05a0xFmMYu3mSmfgH2PDC2qAsByjOlU5yQDv2hTEBEle0c2N2-z1mL-udi49a1FreedSX0Vxm04RTFTO4UwZUO4TGsLu47JheVPuMUN5V4FUCpXPX6qoyiBrGHPWx6cfjYzEK0joJeNi9Q5LwMjZxmJ_1K2P13lTcw67fJEHQeBoiYles4TJXzgmKpYJtGRMdcdiLj8zFiDZYnq31imndZTjfIT5oTY5owEfKRCcfxoDjFMi7mrr0zpi1Tx9bGDUQLD50aoa3M1zqSQvOqi6StvWE-vDGYbRE3oNRIOtL5xQslLMLsvEK4etz_CsYW0WJ-tu_rKs7muU5yM0gIW2pCFiMbNGzJp37uFrxTD5LGn3b-r0gNhMWLYKGzYRIeyRWir2vymf2I0RX5wL5s" } ], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```