--- updatedAt: 2026-04-24T17:23:11.000Z agentTools: projectIndex: https://developer.deputy.com/llms.txt --- # Search CustomFieldData Flexible search endpoint. Body supports `search`, `sort`, `start`, `max`, and `join` clauses. Example: `{"search": {"s1": {"field": "Id", "data": 1, "type": "eq"}}}`. # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "Deputy V1 Resource API", "version": "1.0.0", "description": "Generated, comprehensive reference for Deputy's legacy V1 `/resource/{Object}` API.\n\nV1 is in maintenance mode — new integrations should prefer the V2 API. This spec covers the reflection-based routing pattern declared in `deputy-webapp/app/api/v1/routers/ResourceRouter.php`, enumerated over every ORM class registered in `DeputecApplication::$arrSystems` in `app/prepend.inc.php`.\n\nResources support create/update/delete only if they also appear in `$arrSystemsAPIEditable` — read-only resources expose GET / QUERY / INFO / PREDICT / HISTORY only." }, "servers": [ { "url": "https://{subdomain}.{region}.deputy.com/api/v1", "description": "Deputy tenant", "variables": { "subdomain": { "default": "your-subdomain" }, "region": { "default": "deputy", "enum": [ "au", "eu", "na", "deputy" ] } } } ], "components": { "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "description": "OAuth 2.0 access token or Deputy Permanent Token." }, "OAuth2": { "type": "oauth2", "flows": { "authorizationCode": { "authorizationUrl": "https://once.deputy.com/my/oauth/login", "tokenUrl": "https://once.deputy.com/my/oauth/access_token", "scopes": { "longlife_refresh_token": "Extended session" } } } } }, "schemas": { "CustomFieldData": { "type": "object", "properties": { "Id": { "type": "integer" }, "System": { "type": "string", "maxLength": 32 }, "F01": { "type": "string" }, "F02": { "type": "string" }, "F03": { "type": "string" }, "F04": { "type": "string" }, "F05": { "type": "string" }, "F06": { "type": "string" }, "F07": { "type": "string" }, "F08": { "type": "string" }, "F09": { "type": "string" }, "F10": { "type": "string" }, "F11": { "type": "string" }, "F12": { "type": "string" }, "F13": { "type": "string" }, "F14": { "type": "string" }, "F15": { "type": "string" }, "F16": { "type": "string" }, "F17": { "type": "string" }, "F18": { "type": "string" }, "F19": { "type": "string" }, "F20": { "type": "string" }, "F21": { "type": "string" }, "F22": { "type": "string" }, "F23": { "type": "string" }, "F24": { "type": "string" }, "F25": { "type": "string" }, "F26": { "type": "string" }, "F27": { "type": "string" }, "F28": { "type": "string" }, "F29": { "type": "string" }, "F30": { "type": "string" }, "F31": { "type": "string" }, "F32": { "type": "string" }, "F33": { "type": "string" }, "F34": { "type": "string" }, "F35": { "type": "string" }, "F36": { "type": "string" }, "F37": { "type": "string" }, "F38": { "type": "string" }, "F39": { "type": "string" }, "F40": { "type": "string" }, "F41": { "type": "string" }, "F42": { "type": "string" }, "F43": { "type": "string" }, "F44": { "type": "string" }, "F45": { "type": "string" }, "F46": { "type": "string" }, "F47": { "type": "string" }, "F48": { "type": "string" }, "F49": { "type": "string" }, "F50": { "type": "string" }, "F51": { "type": "string" }, "F52": { "type": "string" }, "F53": { "type": "string" }, "F54": { "type": "string" }, "F55": { "type": "string" }, "F56": { "type": "string" }, "F57": { "type": "string" }, "F58": { "type": "string" }, "F59": { "type": "string" }, "F60": { "type": "string" }, "F61": { "type": "string" }, "F62": { "type": "string" }, "F63": { "type": "string" }, "F64": { "type": "string" }, "F65": { "type": "string" }, "F66": { "type": "string" }, "F67": { "type": "string" }, "F68": { "type": "string" }, "F69": { "type": "string" }, "F70": { "type": "string" }, "F71": { "type": "string" }, "F72": { "type": "string" }, "F73": { "type": "string" }, "F74": { "type": "string" }, "F75": { "type": "string" }, "F76": { "type": "string" }, "F77": { "type": "string" }, "F78": { "type": "string" }, "F79": { "type": "string" }, "F80": { "type": "string" }, "F81": { "type": "string" }, "F82": { "type": "string" }, "F83": { "type": "string" }, "F84": { "type": "string" }, "F85": { "type": "string" }, "F86": { "type": "string" }, "F87": { "type": "string" }, "F88": { "type": "string" }, "F89": { "type": "string" }, "F90": { "type": "string" }, "F91": { "type": "string" }, "F92": { "type": "string" }, "F93": { "type": "string" }, "F94": { "type": "string" }, "F95": { "type": "string" }, "F96": { "type": "string" }, "F97": { "type": "string" }, "F98": { "type": "string" }, "F99": { "type": "string" }, "F100": { "type": "string" }, "F101": { "type": "string" }, "F102": { "type": "string" }, "F103": { "type": "string" }, "F104": { "type": "string" }, "F105": { "type": "string" }, "F106": { "type": "string" }, "F107": { "type": "string" }, "F108": { "type": "string" }, "F109": { "type": "string" }, "F110": { "type": "string" }, "F111": { "type": "string" }, "F112": { "type": "string" }, "F113": { "type": "string" }, "F114": { "type": "string" }, "F115": { "type": "string" }, "F116": { "type": "string" }, "F117": { "type": "string" }, "F118": { "type": "string" }, "F119": { "type": "string" }, "F120": { "type": "string" }, "F121": { "type": "string" }, "F122": { "type": "string" }, "F123": { "type": "string" }, "F124": { "type": "string" }, "F125": { "type": "string" }, "F126": { "type": "string" }, "F127": { "type": "string" }, "F128": { "type": "string" }, "Creator": { "type": "integer" }, "Created": { "type": "string", "format": "date-time" }, "Modified": { "type": "string" } }, "required": [ "Id", "System", "Modified" ] }, "QueryRequest": { "type": "object", "description": "V1 Resource search payload. All fields optional; an empty body returns the first page of results.", "properties": { "search": { "type": "object", "description": "Map of search clauses keyed by an arbitrary id (e.g. `s1`, `s2`). Each clause filters one field.", "additionalProperties": { "type": "object", "required": [ "field", "data", "type" ], "properties": { "field": { "type": "string", "description": "Field name to filter on (e.g. `Id`, `Employee`)." }, "data": { "description": "Comparison value. Type depends on the field." }, "type": { "type": "string", "description": "Comparison operator.", "enum": [ "eq", "ne", "gt", "lt", "ge", "le", "is", "is not", "in", "not in", "starts", "contains" ] } } } }, "sort": { "type": "object", "description": "Map of field name → `asc` or `desc`.", "additionalProperties": { "type": "string", "enum": [ "asc", "desc" ] } }, "start": { "type": "integer", "minimum": 0, "default": 0, "description": "Pagination offset (0-indexed)." }, "max": { "type": "integer", "minimum": 1, "maximum": 500, "default": 100, "description": "Max records per page (server caps at 500)." }, "join": { "type": "array", "items": { "type": "string" }, "description": "Related ORMs to expand inline (e.g. `[\"EmployeeObject\"]`)." } }, "example": { "search": { "s1": { "field": "Id", "data": 1, "type": "ge" } }, "max": 100 } } } }, "security": [ { "BearerAuth": [] }, { "OAuth2": [] } ], "tags": [ { "name": "CustomFieldData", "description": "Operations on the CustomFieldData resource" } ], "paths": { "/resource/CustomFieldData/QUERY": { "post": { "tags": [ "CustomFieldData" ], "summary": "Search CustomFieldData", "description": "Flexible search endpoint. Body supports `search`, `sort`, `start`, `max`, and `join` clauses. Example: `{\"search\": {\"s1\": {\"field\": \"Id\", \"data\": 1, \"type\": \"eq\"}}}`.", "operationId": "searchCustomFieldData", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueryRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldData" } } } } }, "400": { "description": "Bad request" }, "401": { "description": "Authentication required or invalid token" }, "403": { "description": "Forbidden — token lacks access to this resource" }, "404": { "description": "Resource not found" } } } } } } ```