Binders
A binder is the top-level container in iBinder. Each binder groups related documents and exposes its own metadata schema. Most integrations only need two binder endpoints: one to enumerate the binders a tenant has access to, and one to introspect a binder's metadata schema.
Authentication
All endpoints require an OAuth 2.0 access token and the x-ibinder-tenantid header. See the Authentication guide.
Listing binders
The first call most integrations make. Returns every binder visible to the calling client. Binder identifiers are 9-character NanoIds — keep these around; you will pass them to the Documents API as GLOBAL_BinderId filters.
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.
Discovering a binder's metadata schema
Each binder has its own metadata schema. Some keys are iBinder-defined (GLOBAL_* — see the Internal metadata keys reference); others are customer-defined and unique to a particular binder. Use this endpoint at runtime to discover what's available before constructing filters or upload metadata payloads.
Returned elements include the key id, label, data type, and — for enumerated keys — the allowed values together with their valueIds.
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.