Bindbee

Bindbee Custom Fields API

The Custom Fields API from Bindbee — 7 operation(s) for custom fields.

GitHub OpenAPI

Operations 12

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /api/v1/custom-fields Define a new custom field · Create Custom Field #
Ask an LLM
“How do I define a new custom field on a unified model?”
“Can I add an extra field to the employee model for my organization?”
Tell an agent
Create custom field {name} on model {model} in category {category}.
Define custom field {name} for {category} {model} described as {description}.
GET /api/v1/custom-fields List custom field definitions · List Custom Fields #
Ask an LLM
“Which custom fields has my organization defined?”
“Can I filter custom field definitions by category and model?”
Tell an agent
List custom fields for category {category} and model {model}.
Show custom field definitions from source {source}.
POST /api/v1/custom-fields/mapping Map a custom field to source data · Create Custom Field Mapping #
Ask an LLM
“How do I tell a custom field where to read its value from in the source system?”
“Can I scope a mapping to just one connector instead of the whole integration?”
Tell an agent
Map custom field {custom_field_id} to path {json_path} for integration {integration_slug}.
Create a connector-level mapping of field {custom_field_id} to {json_path} for connector {connector_token}.
GET /api/v1/custom-fields/mapping List custom field mappings · List Custom Field Mappings #
Ask an LLM
“Which JMESPath mappings are set up for an integration?”
“Can I see the field mappings that apply to one connector?”
Tell an agent
List custom field mappings for integration {integration_slug}.
Show mappings scoped to connector token {connector_token}.
PATCH /api/v1/custom-fields/mapping/{custom_field_mapping_id} Change a mapping's JMESPath · Update Custom Field Mapping #
Ask an LLM
“How do I fix the JMESPath expression on an existing mapping?”
“What can I change on a mapping after it is created?”
Tell an agent
Change mapping {custom_field_mapping_id} to use path {json_path}.
Update the JMESPath of mapping {custom_field_mapping_id} to {json_path}.
DELETE /api/v1/custom-fields/mapping/{custom_field_mapping_id} Delete a custom field mapping · Delete Custom Field Mapping #
Ask an LLM
“How do I remove a mapping without deleting the custom field itself?”
“Can I drop one connector's override mapping?”
Tell an agent destructive · confirm first
Delete custom field mapping {custom_field_mapping_id}.
Remove mapping {custom_field_mapping_id} from its custom field.
GET /api/v1/custom-fields/raw-data Inspect raw upstream data for a model · Get Raw Data #
Ask an LLM
“What does the raw payload from the source system look like before I write a JMESPath?”
“Can I inspect upstream employee data to discover which fields exist?”
Tell an agent
Show raw upstream data for {category} {model} on connector {connector_token}.
Inspect the source payload for model {model} in category {category}.
POST /api/v1/custom-fields/preview Test a JMESPath before saving a mapping · Preview Custom Field #
Ask an LLM
“Can I dry-run a JMESPath expression against real connector data first?”
“How do I check what value a mapping would extract without saving it?”
Tell an agent
Preview what {json_path} returns for {category} {model} on connector {connector_token}.
Dry-run expression {json_path} against model {model} in {category} for connector {connector_token}.
GET /api/v1/custom-fields/configuration Get effective custom field setup for a connector · Get Custom Fields Configuration #
Ask an LLM
“Which mapping actually applies to each custom field on a given connector?”
“Can I see whether a field uses a connector override or the organization default?”
Tell an agent
Show the effective custom field configuration for {category} {model} on connector {connector_token}.
Get every custom field and its resolved mapping for connector {connector_token}, model {model}, category {category}.
GET /api/v1/custom-fields/{custom_field_id} Get one custom field with its mappings · Get Custom Field #
Ask an LLM
“What mappings are attached to one custom field?”
“Can I view a single custom field definition by id?”
Tell an agent
Get custom field {custom_field_id}.
Show custom field {custom_field_id} and all of its mappings.
PATCH /api/v1/custom-fields/{custom_field_id} Rename or edit a custom field · Update Custom Field #
Ask an LLM
“Can I change a custom field's category or model after creating it?”
“How do I rename a custom field or update its description?”
Tell an agent
Rename custom field {custom_field_id} to {name}.
Update the description of custom field {custom_field_id} to {description}.
DELETE /api/v1/custom-fields/{custom_field_id} Delete a custom field · Delete Custom Field #
Ask an LLM
“How do I delete a custom field definition I no longer use?”
“Can I remove a custom field entirely from my organization?”
Tell an agent destructive · confirm first
Delete custom field {custom_field_id}.
Remove the custom field definition {custom_field_id}.

Documentation

📖
Documentation
https://docs.bindbee.dev/
📖
APIReference
https://docs.bindbee.dev/api-reference/basics/authentication

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/bindbee/refs/heads/main/openapi/bindbee-custom-fields-api-openapi.yml

Other Resources

🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/bindbee/refs/heads/main/data-model/bindbee-data-model.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/bindbee/refs/heads/main/errors/bindbee-problem-types.yml
🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/bindbee/refs/heads/main/mcp/bindbee-tool-crosswalk.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/bindbee:bindbee-custom-fields-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

bindbee-custom-fields-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Bindbee Custom Fields API
  version: 0.1.0
tags:


# --- truncated at 32 KB (53 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bindbee/refs/heads/main/openapi/bindbee-custom-fields-api-openapi.yml