Introduction

This documentation describes the public iBinder File API and how to integrate with it.

Start here: API access is gated

API clients are not enabled by default. Before you can call anything, an organization owner needs to contact iBinder support and ask for API clients to be enabled on the organization. See Obtaining API credentials for the full setup, then walk through the Quickstart to make your first request.

The rest of the site is organized into:

• Obtaining API credentials — how an organization owner creates an API client and finds the organization id.
• Authentication — how to exchange those credentials for an OAuth 2.0 access token.
• Quickstart — token → list binders → search documents → download, end-to-end.
• Documents reference — endpoints for searching, retrieving, and uploading documents.
• Binders reference — listing binders and inspecting their metadata schemas.
• Internal metadata keys — the GLOBAL_* keys you'll encounter on documents.
• API behavior and guidelines — error handling, versioning, rate limits.
• Pagination, filtering & sorting — how list and search endpoints work.

This site documents a curated subset of iBinder's API. The full internal surface is larger; if your integration needs functionality not described here, please contact iBinder.

A Postman collection covers the same endpoints and is the fastest way to try the API out interactively.

API hosting

All APIs are hosted on:

https://api.ibinder.com/api

What you can do

• Document search & filtering — retrieve documents using metadata filters and free-text search.
• Version management — access historical versions of documents.
• File upload & download — use short-lived presigned URLs for controlled file transfers.
• Authentication — OAuth 2.0 client credentials.

Key concepts

Multi-tenancy

The iBinder platform is multi-tenant. Each customer (tenant) has its own isolated environment with its own data and configuration.

Every request must specify the tenant by setting the mandatory x-ibinder-tenantid header:

x-ibinder-tenantid: <your-organization-id>

The value is the Organisations id shown in the iBinder UI — see Find your organization id.

Documents and document versions

A document represents a logical file with a filename and a location inside a binder. Documents own one or more document versions — each version holds the actual binary file, version label, status, custom metadata, and a short-lived presigned download URL.

Binders

A binder is the top-level container in iBinder. Each binder groups related documents and defines its own metadata schema. The metadata schema is what you filter on when searching for documents.

Metadata

Documents carry metadata. iBinder-defined keys (such as GLOBAL_BinderId, GLOBAL_TabId) are prefixed with GLOBAL_. Customers can define additional keys through binder configuration. See Internal metadata keys for the reserved ones, and use GET /binders/{id}/metadataelements at runtime to discover the keys configured on a specific binder.