{"id":19640153,"url":"https://github.com/gearplug/getresponse-python","last_synced_at":"2025-04-28T11:31:04.135Z","repository":{"id":57434073,"uuid":"103940049","full_name":"GearPlug/getresponse-python","owner":"GearPlug","description":"GetResponse API wrapper written in Python.","archived":false,"fork":false,"pushed_at":"2023-03-28T14:11:12.000Z","size":40,"stargazers_count":5,"open_issues_count":2,"forks_count":11,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-18T14:25:38.427Z","etag":null,"topics":["api","api-wrapper","getresponse","python","wrapper","wrapper-api"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GearPlug.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-09-18T13:04:45.000Z","updated_at":"2023-08-03T09:57:47.000Z","dependencies_parsed_at":"2023-02-16T08:05:14.200Z","dependency_job_id":null,"html_url":"https://github.com/GearPlug/getresponse-python","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GearPlug%2Fgetresponse-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GearPlug%2Fgetresponse-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GearPlug%2Fgetresponse-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GearPlug%2Fgetresponse-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GearPlug","download_url":"https://codeload.github.com/GearPlug/getresponse-python/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251304788,"owners_count":21567938,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["api","api-wrapper","getresponse","python","wrapper","wrapper-api"],"created_at":"2024-11-11T14:04:49.911Z","updated_at":"2025-04-28T11:31:03.349Z","avatar_url":"https://github.com/GearPlug.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"![](https://img.shields.io/badge/version-0.1.4-success) ![](https://img.shields.io/badge/Python-3.8%20|%203.9%20|%203.10%20|%203.11-4B8BBE?logo=python\u0026logoColor=white)\n# getresponse-python\n\n*getresponse-python* is an API wrapper for GetResponse written in Python.\n\n## Installing\n\n```\npip install getresponse-python\n```\n\n## Usage\n\n```\nfrom getresponse.client import GetResponse\nfrom getresponse.excs import UniquePropertyError\n\ngetresponse = GetResponse('YOUR_API_KEY_HERE')\n```\nFor GetResponse Enterprise platform:\n```\nfrom getresponse.client import GetResponseEnterprise\n\ngetresponse = GetResponseEnterprise('YOUR_API_KEY_HERE', 'YOUR_DOMAIN_NAME', 'YOUR_API_ENDPOINT')\n```\nGet account info:\n```\naccount = getresponse.accounts()\n\nprint('Account:', account.id, account.name)\n```\nGet all campaigns:\n```\ncampaigns = getresponse.get_campaigns({'sort': {'name', 'desc'}})\n\nfor campaign in campaigns:\n    print('Campaign:' campaign.id, campaign.name)\n```\nGet a campaign:\n```\ncampaign = getresponse.get_campaign('CAMPAIGN_ID_HERE')\n\nprint('Campaign:', campaign.id, campaign.name)\n```\nCreate a campaign:\n```\ncampaign = {\n   \"name\": 'UNIQUE_ID_HERE',\n}\n\ntry:\n   campaign = getresponse.create_campaign(campaign)\n   print('Campaign:', campaign.id, campaign.name)\nexcept UniquePropertyError:\n   print(\"Cannot create: campaign's name already exists.\")\n```\nGet all contacts:\n```\n# Example:\ncontacts = getresponse.get_contacts({'sort[createdOn]': 'ASC', 'query[name]': 'juan'})\nfor contact in contacts:\n    print('Contact:', contact.id, contact.name)\n```\nGet a contact:\n```\ncontact = getresponse.get_contact('CONTACT_ID_HERE')\nif contact:\n    print('Contact:', contact.id, contact.name)\n```\nCreate a contact:\n```\nvalues = {\n    \"email\": \"CONTACT_EMAIL_HERE\",\n    \"campaign\": {\n        'campaignId': 'CAMPAIGN_ID_HERE',\n    },\n}\n\ntry:\n    contact = getresponse.create_contact(values)\n    print('Contact in queue to be created.')\nexcept UniquePropertyError:\n    print(\"Cannot created: contact's email already exists.\")\n```\nDelete a contact:\n```\ncontact = getresponse.delete_contact('CONTACT_ID_HERE')\n```\nUpdate a contact:\n```\nbody = {\n    \"name\": \"Test Name\",\n    \"customFieldValues\": [\n        {\"customFieldId\": \"pLQSI0\", \"value\": [\"comment 1234\"]},\n        {\"customFieldId\": \"pLQSu3\", \"value\": [\"+573108889999\"]},\n    ],\n}\ncontact = getresponse.update_contact(self, contact_id, body)\n```\nGet all custom fields:\n```\ncustom_fields = getresponse.get_custom_fields({'sort': {'name', 'desc'}})\nfor custom_field in custom_fields:\n    print('Custom Field:', custom_field.id, custom_field.name)\n```\nGet a custom field:\n```\ncustom_field = getresponse.get_custom_field('CUSTOM_FIELD_ID_HERE')\nif custom_field:\n    print('Custom Field:', custom_field.id, custom_field.name)\n```\n## Requirements\n- requests\n\n## Contributing\nWe are always grateful for any kind of contribution including but not limited to bug reports, code enhancements, bug fixes, and even functionality suggestions.\n#### You can report any bug you find or suggest new functionality with a new [issue](https://github.com/GearPlug/getresponse-python/issues).\n#### If you want to add yourself some functionality to the wrapper:\n1. Fork it ( https://github.com/GearPlug/getresponse-python )\n2. Create your feature branch (git checkout -b my-new-feature)\n3. Commit your changes (git commit -am 'Adds my new feature')\n4. Push to the branch (git push origin my-new-feature)\n5. Create a new Pull Request\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgearplug%2Fgetresponse-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgearplug%2Fgetresponse-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgearplug%2Fgetresponse-python/lists"}