Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zoho Field API

The Field API from Zoho — 4 operation(s) for field.

Zoho Field API is one of 205 APIs that Zoho publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Field. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and code examples.

This API exposes 7 operations across 4 paths, and defines 94 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

7 operations 4 paths 94 schemas 4 GET2 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Authentication
custom
Resource Areas
1

Authentication & Security 1

Zoho Field API declares 1 security scheme for authenticating requests. It defines a custom scheme (iam-oauth2-schema).

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 4 GET, 2 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Field 7
GET
/api/v1/organizationFields/{fieldId}
Get Field
getField 2 params → 200422
PATCH
/api/v1/organizationFields/{fieldId}
Update Field
updateField 2 params body → 200422
GET
/api/v1/organizationFields/{fieldId}/permissions
Get Field Permissions
getFieldPermissions 2 params → 200
PATCH
/api/v1/organizationFields/{fieldId}/permissions
Update Field Permissions
updateFieldPermissions 2 params body → 200
GET
/api/v1/customFieldCount
Get Custom Field Count
getCustomFieldCount 2 params → 200422
GET
/api/v1/organizationFields
Get Fields
getFields 3 params → 200422
POST
/api/v1/organizationFields
Create Field
createField 2 params body → 201403422

Schemas 94

The contract defines 94 schemas that model the data the API accepts and returns. The most detailed are currencyFieldJson (7 properties), decimalFieldJson (5 properties), phoneFieldJson (4 properties), textFieldJson (4 properties). Each schema is shown below with its type and property counts.

getMultiPickListFieldResponse
urlFieldResponse
createDateFieldResponse
editDateTimeFieldResponse
largeTextFieldResponse
booleanFieldResponseForTickets
dateFieldJson
objectnull
3 properties 3 required
getCurrencyFieldResponse
editPercentFieldResponse
integerFieldJson
objectnull
4 properties 3 required
createTextAreaFieldResponse
emailFieldResponseForTickets
editTextAreaFieldResponse
editLargeTextFieldResponse
getDateTimeFieldResponse
editIntegerFieldResponse
editURLFieldResponse
createDecimalFieldResponse
urlFieldResponseForTickets
decimalFieldResponseForTickets
currencyFieldResponse
textFieldResponseForTickets
pickListFieldRequestJson
objectnull
3 properties 3 required
getTextFieldResponse
getDecimalFieldResponse
integerFieldResponse
percentFieldJson
objectnull
3 properties 3 required
createCurrencyFieldResponse
pickListFieldBasicResponseForTickets
dateTimeFieldJson
objectnull
3 properties 3 required
phoneFieldResponseForTickets
textAreaFieldJson
objectnull
3 properties 3 required
currencyFieldResponseForTickets
multiPickListFieldBasicResponse
editDateFieldResponse
textAreaFieldResponseForTickets
getURLFieldResponse
textFieldJson
objectnull
4 properties 3 required
multiPickListFieldJson
objectnull
3 properties 3 required
editTextFieldResponse
createIntegerFieldResponse
createDateTimeFieldResponse
emailFieldJson
objectnull
3 properties 3 required
editPickListFieldResponse
pickListFieldResponseForTickets
editMultiPickListFieldResponse
dateFieldResponseForTickets
phoneFieldResponse
getBooleanFieldResponse
createTextFieldResponse
editCurrencyFieldResponse
getPercentFieldResponse
pickListFieldResponse
dateFieldResponse
createEmailFieldResponse
largeTextFieldResponseForTickets
largeTextFieldJson
objectnull
4 properties 3 required
getEmailFieldResponse
editDecimalFieldResponse
createBooleanFieldResponse
createPickListFieldResponse
multiPickListFieldResponse
editPhoneFieldResponse
decimalFieldResponse
getPickListFieldResponse
getLargeTextFieldResponse
createLargeTextFieldResponse
booleanFieldResponse
phoneFieldJson
objectnull
4 properties 4 required
textFieldResponse
getIntegerFieldResponse
createPercentFieldResponse
getPhoneFieldResponse
createURLFieldResponse
integerFieldResponseForTickets
multiPickListFieldResponseForTickets
currencyFieldJson
objectnull
7 properties 4 required
textAreaFieldResponse
percentFieldResponse
createMultiPickListFieldResponse
editBooleanFieldResponse
urlFieldJson
objectnull
3 properties 3 required
booleanFieldJson
objectnull
4 properties 3 required
percentFieldResponseForTickets
editEmailFieldResponse
decimalFieldJson
objectnull
5 properties 5 required
dateTimeFieldResponseForTickets
getTextAreaFieldResponse
emailFieldResponse
createPhoneFieldResponse
dateTimeFieldResponse
multiPickListFieldBasicResponseForTickets
pickListFieldBasicResponse
getDateFieldResponse

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoho-field-api-openapi.yml Raw ↑

Other APIs Zoho publishes across the network.

Zoho Inventory
Zoho Books
Zoho Invoice
Zoho Billing
Zoho Expense
Zoho People
Zoho Recruit
Zoho Projects
Zoho Mail
Zoho Sign
Zoho Campaigns
Zoho SalesIQ