Full reference
Every endpoint in the public iBinder API, generated directly from the OpenAPI specification.
For curated, prose-led walkthroughs of the most common flows, see Documents and Binders instead.
Public API for the iBinder platform.
This is a curated subset of the iBinder API surface, covering the most
common document and binder operations. The full internal API is larger;
contact iBinder if your integration needs functionality not described here.
Contact
Servers
Binders
List binders the tenant has access to, and inspect the metadata schema configured on each binder.
List binders
List all binders the caller's tenant has access to.
Authorizations
OAuth 2.0 Client Credentials flow. Obtain a token from the iBinder Identity
Provider, then send it as Authorization: Bearer <token> on every request.
The token endpoint expects grant_type=client_credentials, your client_id,
your client_secret, and scope=ibinder_public.
clientCredentials Flow
"https://signin.ibinder.com/connect/token""ibinder_public"
Parameters
Header Parameters
Responses
The request has succeeded.
Get metadata definitions for binder
List the metadata element definitions configured on a binder. Use this to
discover which metadataElementId values can be used when filtering
documents in that binder, and what each one means.
Authorizations
OAuth 2.0 Client Credentials flow. Obtain a token from the iBinder Identity
Provider, then send it as Authorization: Bearer <token> on every request.
The token endpoint expects grant_type=client_credentials, your client_id,
your client_secret, and scope=ibinder_public.
clientCredentials Flow
"https://signin.ibinder.com/connect/token""ibinder_public"
Parameters
Header Parameters
Path Parameters
Binder identifier (9-character NanoId).
Responses
The request has succeeded.
Documents
Manage documents, document versions, folders, and the upload flow.
Operations
Search/filter documents
Search and filter documents across the tenant. Combines metadata filters,
sorting, and free-text search; supports server-side pagination via the
pageSize, pageNumber, and searchTerm query parameters.
Common patterns:
- Filter to a binder:
MetadataFilters[].metadataElementId = GLOBAL_BinderIdwith the binder id asvalueId. - Filter to a tab/folder:
GLOBAL_TabIdwith the tab id asvalueId. - Sort by category:
SortBy[].metadataElementId = GLOBAL_Category.
Authorizations
OAuth 2.0 Client Credentials flow. Obtain a token from the iBinder Identity
Provider, then send it as Authorization: Bearer <token> on every request.
The token endpoint expects grant_type=client_credentials, your client_id,
your client_secret, and scope=ibinder_public.
clientCredentials Flow
"https://signin.ibinder.com/connect/token""ibinder_public"
Parameters
Header Parameters
Query Parameters
Number of items per page. Defaults to a server-defined value.
"int32"1-based page number.
"int32"Free-text search term applied to document names.
Request Body
Responses
The request has succeeded.
List folders in drive
List the top-level folders/tabs of a drive. A drive is identified by a
domain (e.g. binders) and an id of an object in that domain
(typically a binder id, a 9-character NanoId).
Authorizations
OAuth 2.0 Client Credentials flow. Obtain a token from the iBinder Identity
Provider, then send it as Authorization: Bearer <token> on every request.
The token endpoint expects grant_type=client_credentials, your client_id,
your client_secret, and scope=ibinder_public.
clientCredentials Flow
"https://signin.ibinder.com/connect/token""ibinder_public"
Parameters
Header Parameters
Path Parameters
Drive domain. Most commonly binders.
Object identifier within the domain. For binders this is a 9-character NanoId.
Responses
The request has succeeded.
List folders in folder
List the sub-folders of a folder within a drive.
Authorizations
OAuth 2.0 Client Credentials flow. Obtain a token from the iBinder Identity
Provider, then send it as Authorization: Bearer <token> on every request.
The token endpoint expects grant_type=client_credentials, your client_id,
your client_secret, and scope=ibinder_public.
clientCredentials Flow
"https://signin.ibinder.com/connect/token""ibinder_public"
Parameters
Header Parameters
Path Parameters
Identifier of the parent folder (typically a GUID).
Responses
The request has succeeded.
List documents in folder
List documents in a folder. The folder is identified by a drive
(domain + id) and a folderId (typically a TabId GUID within a binder).
Authorizations
OAuth 2.0 Client Credentials flow. Obtain a token from the iBinder Identity
Provider, then send it as Authorization: Bearer <token> on every request.
The token endpoint expects grant_type=client_credentials, your client_id,
your client_secret, and scope=ibinder_public.
clientCredentials Flow
"https://signin.ibinder.com/connect/token""ibinder_public"
Parameters
Header Parameters
Path Parameters
Responses
The request has succeeded.
Commit uploaded file as document version
Step 3 of the three-step upload flow: after PUTting the file to the
presigned URL, commit the upload into a new document version in the target
folder. Metadata supplied here is attached to the resulting version.
Authorizations
OAuth 2.0 Client Credentials flow. Obtain a token from the iBinder Identity
Provider, then send it as Authorization: Bearer <token> on every request.
The token endpoint expects grant_type=client_credentials, your client_id,
your client_secret, and scope=ibinder_public.
clientCredentials Flow
"https://signin.ibinder.com/connect/token""ibinder_public"
Parameters
Header Parameters
Path Parameters
Request Body
Responses
The request has succeeded.
Get new presigned URL for upload
Step 1 of the three-step upload flow: request a one-shot presigned URL that
accepts a PUT of the file contents. The returned uploadId is then passed
to the commit endpoint after the PUT completes.
Authorizations
OAuth 2.0 Client Credentials flow. Obtain a token from the iBinder Identity
Provider, then send it as Authorization: Bearer <token> on every request.
The token endpoint expects grant_type=client_credentials, your client_id,
your client_secret, and scope=ibinder_public.
clientCredentials Flow
"https://signin.ibinder.com/connect/token""ibinder_public"
Responses
The request has succeeded.
Get document
Fetch a document by its identifier. The response describes the document's metadata and latest version pointer.
Authorizations
OAuth 2.0 Client Credentials flow. Obtain a token from the iBinder Identity
Provider, then send it as Authorization: Bearer <token> on every request.
The token endpoint expects grant_type=client_credentials, your client_id,
your client_secret, and scope=ibinder_public.
clientCredentials Flow
"https://signin.ibinder.com/connect/token""ibinder_public"
Parameters
Header Parameters
Path Parameters
Document identifier (GUID).
Responses
The request has succeeded.
List document versions
List all versions of a document, ordered by creation date.
Authorizations
OAuth 2.0 Client Credentials flow. Obtain a token from the iBinder Identity
Provider, then send it as Authorization: Bearer <token> on every request.
The token endpoint expects grant_type=client_credentials, your client_id,
your client_secret, and scope=ibinder_public.
clientCredentials Flow
"https://signin.ibinder.com/connect/token""ibinder_public"
Parameters
Header Parameters
Path Parameters
Responses
The request has succeeded.
Get document version
Fetch a specific document version.
Authorizations
OAuth 2.0 Client Credentials flow. Obtain a token from the iBinder Identity
Provider, then send it as Authorization: Bearer <token> on every request.
The token endpoint expects grant_type=client_credentials, your client_id,
your client_secret, and scope=ibinder_public.
clientCredentials Flow
"https://signin.ibinder.com/connect/token""ibinder_public"
Parameters
Header Parameters
Path Parameters
Document version identifier (GUID).
Responses
The request has succeeded.
Get document version download link
Get a short-lived presigned download URL for a document version's binary
content. The returned URL points directly at storage; clients should not
add the Authorization header when fetching it.
Authorizations
OAuth 2.0 Client Credentials flow. Obtain a token from the iBinder Identity
Provider, then send it as Authorization: Bearer <token> on every request.
The token endpoint expects grant_type=client_credentials, your client_id,
your client_secret, and scope=ibinder_public.
clientCredentials Flow
"https://signin.ibinder.com/connect/token""ibinder_public"
Parameters
Header Parameters
Path Parameters
Responses
The request has succeeded.