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 Attachments API

The Attachments API from Zoho — 2 operation(s) for attachments.

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

Tagged areas include Attachments. 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 4 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

4 operations 2 paths 6 schemas 1 DELETE2 GET1 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 Attachments API declares 1 security scheme for authenticating requests. It defines a custom scheme (iam-oauth2-schema).

Paths & Operations 4

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

Attachments 4
GET
/{moduleApiName}/{recordId}/Attachments/{id}
Download a specific attachment file
getAttachmentById 3 params → 200204400401403404429500
DELETE
/{moduleApiName}/{recordId}/Attachments/{id}
Delete Link Attachment
deleteAttachment 3 params → 200400
GET
/{moduleApiName}/{recordId}/Attachments
Retrieve all attachments associated with a specific record
getAttachments 3 params → 200400401403404429500503
POST
/{moduleApiName}/{recordId}/Attachments
Upload an attachment
uploadAttachment 2 params body → 200400401403404413429500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are AttachmentObject (17 properties), Info (7 properties), ErrorResponse (4 properties), BodySizeLimitError (4 properties). Each schema is shown below with its type and property counts.

AttachmentObject
object
Individual attachment metadata
17 properties 5 required
AttachmentListResponse
object
Response containing list of attachments for a record
2 properties 2 required
AttachmentSuccessResponse
object
Successful attachment operation response
1 property 1 required
BodySizeLimitError
object
Error response for body size limit exceeded
4 properties 4 required
ErrorResponse
object
Generic error response structure
4 properties 4 required
Info
object
Pagination information for list responses
7 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoho-attachments-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