{"openapi":"3.1.0","info":{"title":"Copper (BYOK) API","version":"0.1.0","description":"Copper (BYOK) lets an AI assistant read your own Copper data through the Copper API with a key you supply (Copper API key). Read-only: 8 tools (get_account, list_users, search_people, search_companies, search_opportunities, search_tasks, search_activities, search_activities_for_record). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached;...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-copper.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-copper/docs"},"termsOfService":"https://connectorbay.com/byok-copper/terms"},"servers":[{"url":"https://byok-copper.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-copper/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/get_account":{"post":{"operationId":"get_account","summary":"Show the Copper account the key belongs to: account name, time zone and whether team permissions and leads are enabled. ","description":"Show the Copper account the key belongs to: account name, time zone and whether team permissions and leads are enabled. Use for \"Which Copper account is my API key connected to\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_accountArguments","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_users":{"post":{"operationId":"list_users","summary":"List the users of your Copper account with id, name and email. Use for \"Who are the users in my Copper account\".","description":"List the users of your Copper account with id, name and email. Use for \"Who are the users in my Copper account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results per page (1 to 100; the API default is 20).","title":"Page Size"},"page_number":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1. Search results stop after the first 100,000 records.","title":"Page Number"}},"title":"list_usersArguments","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/search_people":{"post":{"operationId":"search_people","summary":"Search Copper people (contacts) by name or location with title, company, emails, phone numbers and interaction counts. D","description":"Search Copper people (contacts) by name or location with title, company, emails, phone numbers and interaction counts. Dates are Unix timestamps. Use for \"Find the Copper contact named Jane Smith\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only people whose name contains this text.","title":"Name"},"city":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only people in this city.","title":"City"},"country":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only people in this country.","title":"Country"},"sort_by":{"anyOf":[{"enum":["name","title","city","state","country","date_created","date_modified"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort field: name, title, city, state, country, date_created or date_modified.","title":"Sort By"},"sort_direction":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction: asc or desc.","title":"Sort Direction"},"minimum_created_date":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only records created at or after this Unix timestamp (seconds).","title":"Minimum Created Date"},"maximum_created_date":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only records created at or before this Unix timestamp (seconds).","title":"Maximum Created Date"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results per page (1 to 100; the API default is 20).","title":"Page Size"},"page_number":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1. Search results stop after the first 100,000 records.","title":"Page Number"}},"title":"search_peopleArguments","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/search_companies":{"post":{"operationId":"search_companies","summary":"Search Copper companies by name or location with email domain, phone numbers, assignee and interaction counts. Dates are","description":"Search Copper companies by name or location with email domain, phone numbers, assignee and interaction counts. Dates are Unix timestamps. Use for \"Find Copper companies with Acme in the name\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only companies whose name contains this text.","title":"Name"},"city":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only companies in this city.","title":"City"},"country":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only companies in this country.","title":"Country"},"sort_by":{"anyOf":[{"enum":["name","city","state","country","date_created","date_modified","last_interaction","interaction_count"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort field: name, city, state, country, date_created, date_modified, last_interaction or interaction_count.","title":"Sort By"},"sort_direction":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction: asc or desc.","title":"Sort Direction"},"minimum_created_date":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only records created at or after this Unix timestamp (seconds).","title":"Minimum Created Date"},"maximum_created_date":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only records created at or before this Unix timestamp (seconds).","title":"Maximum Created Date"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results per page (1 to 100; the API default is 20).","title":"Page Size"},"page_number":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1. Search results stop after the first 100,000 records.","title":"Page Number"}},"title":"search_companiesArguments","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/search_opportunities":{"post":{"operationId":"search_opportunities","summary":"Search Copper opportunities with value, status, pipeline stage, close date and owner. Use sort_by to rank by value or da","description":"Search Copper opportunities with value, status, pipeline stage, close date and owner. Use sort_by to rank by value or date. Dates are Unix timestamps. Use for \"What are my biggest Copper opportunities\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"name":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only the opportunity with exactly this name.","title":"Name"},"sort_by":{"anyOf":[{"enum":["name","status","stage","monetary_value","date_created","date_modified","last_interaction","interaction_count"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort field: name, status, stage, monetary_value, date_created, date_modified, last_interaction or interaction_count.","title":"Sort By"},"sort_direction":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction: asc or desc.","title":"Sort Direction"},"minimum_monetary_value":{"anyOf":[{"minimum":0,"type":"number"},{"type":"null"}],"default":null,"description":"Only opportunities worth at least this amount.","title":"Minimum Monetary Value"},"maximum_monetary_value":{"anyOf":[{"minimum":0,"type":"number"},{"type":"null"}],"default":null,"description":"Only opportunities worth at most this amount.","title":"Maximum Monetary Value"},"minimum_close_date":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only opportunities closing at or after this Unix timestamp (seconds).","title":"Minimum Close Date"},"maximum_close_date":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only opportunities closing at or before this Unix timestamp (seconds).","title":"Maximum Close Date"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results per page (1 to 100; the API default is 20).","title":"Page Size"},"page_number":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1. Search results stop after the first 100,000 records.","title":"Page Number"}},"title":"search_opportunitiesArguments","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/search_tasks":{"post":{"operationId":"search_tasks","summary":"Search Copper tasks with due date, status, priority, assignee and the record each task relates to. Dates are Unix timest","description":"Search Copper tasks with due date, status, priority, assignee and the record each task relates to. Dates are Unix timestamps. Use for \"Which Copper tasks are due soon\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"sort_by":{"anyOf":[{"enum":["name","status","priority","due_date","reminder_date","completed_date","date_created","date_modified"],"type":"string"},{"type":"null"}],"default":"due_date","description":"Sort field: name, status, priority, due_date, reminder_date, completed_date, date_created or date_modified.","title":"Sort By"},"sort_direction":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction: asc or desc.","title":"Sort Direction"},"minimum_due_date":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only tasks due at or after this Unix timestamp (seconds).","title":"Minimum Due Date"},"maximum_due_date":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only tasks due at or before this Unix timestamp (seconds).","title":"Maximum Due Date"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results per page (1 to 100; the API default is 20).","title":"Page Size"},"page_number":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1. Search results stop after the first 100,000 records.","title":"Page Number"}},"title":"search_tasksArguments","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/search_activities":{"post":{"operationId":"search_activities","summary":"Search Copper activity log entries (calls, meetings, notes, system changes) in a date range across all records. Use for ","description":"Search Copper activity log entries (calls, meetings, notes, system changes) in a date range across all records. Use for \"What activity was logged in Copper last week\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"minimum_activity_date":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only activities at or after this Unix timestamp (seconds).","title":"Minimum Activity Date"},"maximum_activity_date":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only activities at or before this Unix timestamp (seconds).","title":"Maximum Activity Date"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results per page (1 to 100; the API default is 20).","title":"Page Size"},"page_number":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1. Search results stop after the first 100,000 records.","title":"Page Number"}},"title":"search_activitiesArguments","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/search_activities_for_record":{"post":{"operationId":"search_activities_for_record","summary":"Search the Copper activity log of one record (person, company, lead or opportunity) by its id. Use for \"What has been lo","description":"Search the Copper activity log of one record (person, company, lead or opportunity) by its id. Use for \"What has been logged on Copper opportunity 12345\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"parent_id":{"description":"Numeric id of the record whose activity to list.","minimum":1,"title":"Parent Id","type":"integer"},"parent_type":{"description":"Kind of record: person, company, lead, opportunity, project or task.","enum":["person","company","lead","opportunity","project","task"],"title":"Parent Type","type":"string"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results per page (1 to 100; the API default is 20).","title":"Page Size"},"page_number":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1. Search results stop after the first 100,000 records.","title":"Page Number"}},"required":["parent_id","parent_type"],"title":"search_activities_for_recordArguments","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}}}}