{"openapi":"3.1.0","info":{"title":"Pipedrive Settings (BYOK) API","version":"0.1.0","description":"Pipedrive Settings (BYOK) lets an AI assistant read your own Pipedrive Settings data through the Pipedrive Settings API with a key you supply (personal API token). Read-only: 10 tools (list_deal_fields, list_person_fields, list_organization_fields, list_product_fields, list_lead_fields, list_activity_types, list_lead_labels, list_lead_sources, list_currencies, list_filters). The BYOK key travels...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-pipedrive-settings.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-pipedrive-settings/docs"},"termsOfService":"https://connectorbay.com/byok-pipedrive-settings/terms"},"servers":[{"url":"https://byok-pipedrive-settings.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-pipedrive-settings/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_deal_fields":{"post":{"operationId":"list_deal_fields","summary":"List the deal fields (standard and custom) with key, label, type, option values and flags such as mandatory and searchab","description":"List the deal fields (standard and custom) with key, label, type, option values and flags such as mandatory and searchable. Field definitions only, no records. Use for \"What custom fields do our Pipedrive deals have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"start":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Index of the first item to return, for paging (0 for the first page).","title":"Start"},"limit":{"anyOf":[{"maximum":500,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many items to return (1 to 500).","title":"Limit"}},"title":"list_deal_fieldsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_person_fields":{"post":{"operationId":"list_person_fields","summary":"List the person fields (standard and custom) with key, label, type, option values and flags such as mandatory and search","description":"List the person fields (standard and custom) with key, label, type, option values and flags such as mandatory and searchable. Field definitions only, no records. Use for \"What fields can a Pipedrive person have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"start":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Index of the first item to return, for paging (0 for the first page).","title":"Start"},"limit":{"anyOf":[{"maximum":500,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many items to return (1 to 500).","title":"Limit"}},"title":"list_person_fieldsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_organization_fields":{"post":{"operationId":"list_organization_fields","summary":"List the organization fields (standard and custom) with key, label, type, option values and flags such as mandatory and ","description":"List the organization fields (standard and custom) with key, label, type, option values and flags such as mandatory and searchable. Field definitions only, no records. Use for \"Which custom fields are on Pipedrive organizations\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"start":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Index of the first item to return, for paging (0 for the first page).","title":"Start"},"limit":{"anyOf":[{"maximum":500,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many items to return (1 to 500).","title":"Limit"}},"title":"list_organization_fieldsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_product_fields":{"post":{"operationId":"list_product_fields","summary":"List the product fields (standard and custom) with key, label, type, option values and flags such as mandatory and searc","description":"List the product fields (standard and custom) with key, label, type, option values and flags such as mandatory and searchable. Field definitions only, no records. Use for \"What fields do Pipedrive products have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"start":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Index of the first item to return, for paging (0 for the first page).","title":"Start"},"limit":{"anyOf":[{"maximum":500,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many items to return (1 to 500).","title":"Limit"}},"title":"list_product_fieldsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_lead_fields":{"post":{"operationId":"list_lead_fields","summary":"List the lead fields (standard and custom) with key, label, type, option values and flags such as mandatory and searchab","description":"List the lead fields (standard and custom) with key, label, type, option values and flags such as mandatory and searchable. Field definitions only, no records. Use for \"Which fields exist on Pipedrive leads\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"start":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Index of the first item to return, for paging (0 for the first page).","title":"Start"},"limit":{"anyOf":[{"maximum":500,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many items to return (1 to 500).","title":"Limit"}},"title":"list_lead_fieldsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_activity_types":{"post":{"operationId":"list_activity_types","summary":"List activity types (call, meeting, task, email and custom ones) with name, icon, colour, order and active flag. Use for","description":"List activity types (call, meeting, task, email and custom ones) with name, icon, colour, order and active flag. Use for \"Which activity types are set up in Pipedrive\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_activity_typesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_lead_labels":{"post":{"operationId":"list_lead_labels","summary":"List lead labels with id, name and colour. Use for \"What lead labels does our Pipedrive account use\".","description":"List lead labels with id, name and colour. Use for \"What lead labels does our Pipedrive account use\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_lead_labelsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_lead_sources":{"post":{"operationId":"list_lead_sources","summary":"List the lead source names defined in the account. Use for \"Which lead sources can we choose in Pipedrive\".","description":"List the lead source names defined in the account. Use for \"Which lead sources can we choose in Pipedrive\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_lead_sourcesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_currencies":{"post":{"operationId":"list_currencies","summary":"List the currencies Pipedrive supports with code, name, symbol and decimal points, optionally filtered by a search term.","description":"List the currencies Pipedrive supports with code, name, symbol and decimal points, optionally filtered by a search term. Use for \"What is the currency code for Swiss franc in Pipedrive\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"term":{"anyOf":[{"maxLength":50,"type":"string"},{"type":"null"}],"default":null,"description":"Text to look for in currency name or code, for example 'chf'.","title":"Term"}},"title":"list_currenciesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_filters":{"post":{"operationId":"list_filters","summary":"List saved filters with name, record type, active flag, owner user id and dates. The filter conditions are not returned.","description":"List saved filters with name, record type, active flag, owner user id and dates. The filter conditions are not returned. Use for \"Which saved deal filters exist in Pipedrive\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"type":{"anyOf":[{"enum":["deals","leads","org","people","products","activity","projects"],"type":"string"},{"type":"null"}],"default":null,"description":"Record type of the filters: deals, leads, org, people, products, activity or projects.","title":"Type"}},"title":"list_filtersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}