Get metadata definitions for binder

GET

/binders/{id}/metadataelements

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

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

string

Required

Path Parameters

id*

Binder identifier (9-character NanoId).

Type

string

Required

Responses

The request has succeeded.

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"label": "string",

  

  

"dataType": "string",

  

  

"allowedValues": [

  

  

  

{

  

  

  

  

"id": "string",

  

  

  

  

"label": "string"

  

  

  

}

  

  

],

  

  

"required": true

  

}

]

GET

/binders/{id}/metadataelements

Playground

Authorization

IBinderOAuth2

Headers

x-ibinder-tenantid*

Variables

Key

Value

id*

Samples

Powered by VitePress OpenAPI