{"id":51121889,"url":"https://github.com/ghidinelli/batchbook-api-coldfusion","last_synced_at":"2026-06-25T03:30:49.505Z","repository":{"id":5949440,"uuid":"7170336","full_name":"ghidinelli/batchbook-api-coldfusion","owner":"ghidinelli","description":"ColdFusion client for Batchbook v2 API at https://github.com/batchblue/batchbook-api","archived":false,"fork":false,"pushed_at":"2012-12-14T19:45:50.000Z","size":116,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2023-04-04T14:13:16.869Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"ColdFusion","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ghidinelli.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-12-14T19:04:57.000Z","updated_at":"2013-10-02T23:48:35.000Z","dependencies_parsed_at":"2022-08-30T18:01:29.917Z","dependency_job_id":null,"html_url":"https://github.com/ghidinelli/batchbook-api-coldfusion","commit_stats":null,"previous_names":[],"tags_count":0,"template":null,"template_full_name":null,"purl":"pkg:github/ghidinelli/batchbook-api-coldfusion","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ghidinelli%2Fbatchbook-api-coldfusion","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ghidinelli%2Fbatchbook-api-coldfusion/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ghidinelli%2Fbatchbook-api-coldfusion/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ghidinelli%2Fbatchbook-api-coldfusion/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ghidinelli","download_url":"https://codeload.github.com/ghidinelli/batchbook-api-coldfusion/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ghidinelli%2Fbatchbook-api-coldfusion/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34758773,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-25T02:00:05.521Z","response_time":101,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-06-25T03:30:47.546Z","updated_at":"2026-06-25T03:30:49.501Z","avatar_url":"https://github.com/ghidinelli.png","language":"ColdFusion","funding_links":[],"categories":[],"sub_categories":[],"readme":"batchbook-api-coldfusion\n========================\n\nColdFusion client for Batchbook v2 API at https://github.com/batchblue/batchbook-api\n\n\nUsage\n========================\nI wrote a helper library for interfacing with REST APIs from ColdFusion.  It's required and you can download it here:\nhttps://github.com/ghidinelli/restconsumer\n\nInitialize the client:\n\n\trestconsumer = createObject(\"component\", \"restconsumer\");\n\tbatchbook = createObject(\"component\", \"batchbook\").init(RestConsumer = restconsumer, APIKey = 'Your-Key', Endpoint = 'https://yourHost.batchbook.com/api/v1');\n\nMake some calls:\n\n\t\u003ccfset res = batchbook.findCompany(name = 'Some Company Name') /\u003e\n\nCheck to see if it succeeds and has content:\n\n\t\u003ccfif res.complete AND res.status EQ 200 AND isJSON(res.content)\u003e\n\t\t\u003ccfdump var=\"#deserializeJSON(res.content)#\" /\u003e\n\t\u003c/cfif\u003e\n\nIf you have a contact ID, get the person or company record:\n\n\t\u003ccfset res = batchbook.getCompany(167) /\u003e\n\t\u003ccfset res = batchbook.getPeople(122) /\u003e\n\n\n\nCreate People (note, for CF8 compatibility which does not maintain case sensitivity in in-line structs/arrays, we use an argumentCollection hack represented as node()).  One CF9+ I think you can just use inline syntax so long as case-sensitivity is maintained (which is required by the BB API):\n\n\t\u003ccfset req = {} /\u003e\n\t\u003ccfset req[\"person\"] = batchbook.node(about = \"All around cool guy.\", first_name = \"Eric\", middle_name = \"M\", last_name = \"Krause\") /\u003e\n\t\u003ccfset req.person[\"emails\"] = [batchbook.node(address = \"bar@example.com\", label = \"work\")] /\u003e\n\t\u003ccfset req.person[\"phones\"] = [batchbook.node(number = \"401.867.5309\", label = \"cell\")] /\u003e\n\t\u003ccfset req.person[\"websites\"] = [batchbook.node(address = \"http://www.batchblue.com\", label = \"work\")] /\u003e\n\t\u003ccfset req.person[\"addresses\"] = [batchbook.node(address_1 = \"171 Chestnut Street\", address_2 = \"2L\", city = \"Providence\", state = \"RI\", postal_code = \"02903\", country = \"United States\", label = \"work\")] /\u003e\n\t\u003ccfset req.person[\"company_affiliations\"] = [batchbook.node(company_id = 1355, current = true, job_title = \"\")] /\u003e\n\t\u003ccfset res = batchbook.savePeople(req) /\u003e\n\nsavePeople() can also update records; it will look for the presence of an ID to determine if it is creating or updating.\n\nCreating a record returns a Location header in the result struct with the URI to the new resource.  You can easily fetch it like this:\n\n\t\u003ccfset res = batchbook.follow(res.headers[\"Location\"]) /\u003e\n\nCompanies are created and updated the same way.  This one includes a custom field set:\n\n\t\u003ccfset req = structNew() /\u003e\n\t\u003ccfset req[\"company\"] = batchbook.node(name = \"Batchbook Test\", about = \"A great company to work for\") /\u003e\n\t\u003ccfset req.company[\"emails\"] = [batchbook.node(address = \"test@test.com\", label = \"work\")] /\u003e\n\t\u003ccfset req.company[\"phones\"] = [batchbook.node(number = \"415.555.1212\", label = \"work\")] /\u003e\n\t\u003ccfset req.company[\"websites\"] = [batchbook.node(address = \"http://www.test.com\", label = \"work\")] /\u003e\n\t\u003ccfset req.company[\"addresses\"] = [batchbook.node(address_1 = \"123 Anywhere Lane\", address_2 = \"Unit 253\", city = \"San Rafael\", state = \"California\", postal_code = \"94903\", country = \"United States\", label = \"work\")] /\u003e\n\t\u003ccfset nested = [batchbook.node(custom_field_definition_id = 38, serialized_value = listToArray(\"New\"))\n\t\t\t\t,batchbook.node(custom_field_definition_id = 11, serialized_value = listToArray(\"Standard Plan - No Fees Whatsoever\"))\n\t\t\t\t,batchbook.node(custom_field_definition_id = 12, text_value = \"foo.com\")\n\t\t\t\t,batchbook.node(custom_field_definition_id = 13, boolean_value = false)\n\t\t\t\t,batchbook.node(custom_field_definition_id = 14, datetime_value = batchbook.formatDate(now()))\n\t\t\t\t,batchbook.node(custom_field_definition_id = 15, text_value = \"Form comments from sales lead\")\n\t\t\t\t] /\u003e\n\t\u003ccfset req.company[\"cf_records\"] = [batchbook.node(custom_field_set_id = 3, custom_field_values = nested)] /\u003e\n\t\u003ccfset res = batchbook.saveCompany(req) /\u003e\n\n(again, in CF9 and above which has better inline array/struct creation, the use of node() is not required.\n\n\nGet all of your custom field set definitions:\n\n\t\u003ccfset res = batchbook.getCustomFields() /\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fghidinelli%2Fbatchbook-api-coldfusion","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fghidinelli%2Fbatchbook-api-coldfusion","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fghidinelli%2Fbatchbook-api-coldfusion/lists"}