{"id":19640183,"url":"https://github.com/gearplug/intercom-python","last_synced_at":"2026-06-10T04:31:19.951Z","repository":{"id":172072965,"uuid":"648721081","full_name":"GearPlug/intercom-python","owner":"GearPlug","description":"intercom-python is an API wrapper for intercom, written in Python.","archived":false,"fork":false,"pushed_at":"2023-06-21T17:32:09.000Z","size":9,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-02-26T22:44:37.379Z","etag":null,"topics":["api","conversations","intercom","lead","oauth","oauth2","python","requests","tags","users","wrapper"],"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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-06-02T16:32:49.000Z","updated_at":"2023-07-30T11:18:53.000Z","dependencies_parsed_at":"2023-07-03T18:01:13.374Z","dependency_job_id":null,"html_url":"https://github.com/GearPlug/intercom-python","commit_stats":null,"previous_names":["gearplug/intercom-python"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/GearPlug/intercom-python","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GearPlug%2Fintercom-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GearPlug%2Fintercom-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GearPlug%2Fintercom-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GearPlug%2Fintercom-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GearPlug","download_url":"https://codeload.github.com/GearPlug/intercom-python/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GearPlug%2Fintercom-python/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34137570,"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-10T02:00:07.152Z","response_time":89,"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":["api","conversations","intercom","lead","oauth","oauth2","python","requests","tags","users","wrapper"],"created_at":"2024-11-11T14:04:56.977Z","updated_at":"2026-06-10T04:31:19.937Z","avatar_url":"https://github.com/GearPlug.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# intercom-python\n![](https://img.shields.io/badge/version-0.1.1-success) ![](https://img.shields.io/badge/Python-3.8%20|%203.9%20|%203.10%20|%203.11-4B8BBE?logo=python\u0026logoColor=white)  \n\n*intercom-python* is an API wrapper for intercom, written in Python.  \nThis library uses Oauth2 for authentication.\n## Installing\n```\npip install intercom-python-2\n```\n## Usage\n```python\n# if you have an access token:\nfrom intercom.client import Client\nclient = Client(access_token=access_token)\n```\n```python\n# if you are using Oauth2 to get an access_token:\nfrom intercom.client import Client\nclient = Client(client_id=client_id, client_secret=client_secret)\n```\nTo obtain and set an access token:\n1. **Get authorization URL**\n```python\nurl = client.authorization_url(redirect_uri)\n```\n2. **Get access token using code**\n```python\nresponse = client.get_access_token(code)\n```\n3. **Set access token**\n```python\nclient.set_token(access_token)\n```\nCheck more information about Intercom Oauth: https://developers.intercom.com/building-apps/docs/setting-up-oauth\n#### Get current user\n```python\nme = client.get_current_user()\n```\n#### List all admins\n```python\nadmins = client.list_all_admins()\n```\n#### List data attributes\n```python\n# model options are: contact, company, conversation\ndata_atts = client.list_data_attributes(model, include_archived=False)\n```\n#### List tags\n```python\ntags = client.list_tags()\n```\n### Contacts\n#### - List all contacts\n```python\ncontacts = client.list_all_contacts()\n```\n#### - Filter contacts\n```python\n# field options: https://developers.intercom.com/intercom-api-reference/reference/searchcontacts\ncontacts = client.filter_contacts(field, operator, value)\n# operator options: =, !=, IN, NIN, \u003c, \u003e, ~, !~, ^, $\n```\n#### - Create contact\n```python\n# role options are: 'user' and 'lead'\n# signed_up_at and last_seen_at use epoch time stamp. For example: 1685986703 equals Monday, 5 June 2023 17:38:23\n# custom_attributes dict structure:\n#     {\"field_name\": \"field_value\", \"field_name\": \"field_value\", ...}\ncontact = client.create_contact(\n    role: str, \n    email: str, \n    external_id: str = None,\n    phone: str = None,\n    name: str = None,\n    avatar: str = None,\n    signed_up_at: int = None,\n    last_seen_at: int = None,\n    owner_id: int = None,\n    unsubscribed: bool = None,\n    custom_attributes: dict = None\n)\n```\n#### - Add tag to contact\n```python\nresponse = client.add_tag_to_contact(contact_id, tag_id)\n```\n#### - Create a note\n```python\ntext = \"this is a note\"\nresponse = client.create_note(contact_id, text)\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgearplug%2Fintercom-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgearplug%2Fintercom-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgearplug%2Fintercom-python/lists"}