Search/filter documents
POST
/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
IBinderOAuth2
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
Token URL
"https://signin.ibinder.com/connect/token"Scopes:
"ibinder_public"
Parameters
Header Parameters
x-ibinder-tenantid*
Type
Requiredstring
Query Parameters
pageSize
Number of items per page. Defaults to a server-defined value.
Type
integer
Format
"int32"pageNumber
1-based page number.
Type
integer
Format
"int32"searchTerm
Free-text search term applied to document names.
Type
string
Request Body
application/json
JSON "MetadataFilters": [ { "metadataElementId": "string", "valueId": "string" } ], "SortBy": [ { "metadataElementId": "string", "direction": "string" } ]
{
}
Responses
The request has succeeded.
application/json
JSON "items": [ { "id": "string", "fileName": "string", "folderId": "string", "binderId": "string", "metadata": [ { "metadataElementId": "string", "valueId": "string" } ], "latestVersionId": "string" } ], "totalCount": 0, "pageNumber": 0, "pageSize": 0
{
}