{"id":19654388,"url":"https://github.com/0xry4n/intercom-python-sdk","last_synced_at":"2025-04-30T20:08:04.925Z","repository":{"id":177081407,"uuid":"659336520","full_name":"0xRy4n/intercom-python-sdk","owner":"0xRy4n","description":"An unofficial Python SDK for the Intercom API and App Canvas.","archived":false,"fork":false,"pushed_at":"2023-11-02T20:58:32.000Z","size":397,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-30T20:07:59.973Z","etag":null,"topics":["intercom","intercom-api","intercom-client","marshmallow","python","uplink"],"latest_commit_sha":null,"homepage":"https://0xry4n.github.io/intercom-python-sdk/","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/0xRy4n.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}},"created_at":"2023-06-27T15:59:10.000Z","updated_at":"2024-04-30T03:39:22.000Z","dependencies_parsed_at":"2023-09-25T23:35:03.558Z","dependency_job_id":"9924e118-badf-4c85-a548-2a62a4d3ba2d","html_url":"https://github.com/0xRy4n/intercom-python-sdk","commit_stats":null,"previous_names":["0xry4n/intercom-python-sdk"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0xRy4n%2Fintercom-python-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0xRy4n%2Fintercom-python-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0xRy4n%2Fintercom-python-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0xRy4n%2Fintercom-python-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/0xRy4n","download_url":"https://codeload.github.com/0xRy4n/intercom-python-sdk/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251774896,"owners_count":21641731,"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":["intercom","intercom-api","intercom-client","marshmallow","python","uplink"],"created_at":"2024-11-11T15:17:10.159Z","updated_at":"2025-04-30T20:08:04.905Z","avatar_url":"https://github.com/0xRy4n.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Intercom Python SDK\n\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/a2dc4c9a2c6c4f648bc8e909cf2bc731)](https://app.codacy.com/gh/0xRy4n/intercom-python-sdk/dashboard?utm_source=gh\u0026utm_medium=referral\u0026utm_content=\u0026utm_campaign=Badge_grade) [![Docs](https://github.com/0xRy4n/intercom-python-sdk/actions/workflows/static.yml/badge.svg)](https://0xry4n.github.io/intercom-python-sdk/) [![Tests](https://github.com/0xRy4n/intercom-python-sdk/actions/workflows/tests.yml/badge.svg)](https://github.com/0xRy4n/intercom-python-sdk/actions/workflows/tests.yml)\n\n### Disclaimer\n\nThis is an unofficial Python SDK for interacting with the Intercom API as defined in the [Intercom API Reference](https://developers.intercom.com/intercom-api-reference/reference). This project is in no way associated with Intercom and is provided as-is without warranty. See the `LICENSE` file for more information.\n\n## Usage\n\n#### Basic\n\nAll functionality to the SDK is provided through a single `Intercom` class which can be imported as follows:\n\n```python\nfrom intercom_python_sdk import Intercom\n```\n\nThe most basic way to authenticate with the SDK is to provide an API Key (Private App Key) as follows:\n\n```python\nimport intercom_python_sdk\n\nintercom = intercom_python_sdk.Intercom(api_key='my_api_key')\n```\n\nYou can then access all sub-APIs through this object, like so:\n\n```python\n\ncur_admin = intercom.admins.me()\nall_admins = intercom.admins.list_admins()\n\nall_data_events = intercom.data_events.list_all()\n```\n\n\n#### Advanced\n\nThe `Intercom` class can support being passed a `Configuration` object. This class itself will expect you to manually build your Authentication object from the `Uplink` library, and gives you access to some additional settings.\n\n```python\nfrom uplink.auth import BearerToken\nfrom intercom_python_sdk import Intercom, Configuration\n\nauth = BearerToken('my_api_key')\nconfig = Configuration(\n    auth=auth, \n    base_url='https://api.intercom.io',\n    api_version=\"2.9\",\n    proxy={'https': 'https://127.0.0.1:8080'} # Optional Proxy for Debug-- see requests.Session proxy documentation\n)\n\nintercom = Intercom(config=config)\n```\n\nFor developers, additional parameters from the underlying library (`Uplink`) are exposed here as well. See the docstrings for more information.\n\n##### Using Individual Sub-APIs\n\nYou also have the ability to create individual clients for a specific API instead of using the Intercom class. This may be useful if you have different credentials for different APIs, or if you want to use the same credentials but different configurations.\n\n```python\n\nfrom intercom_python_sdk import Admins, Configuration, create_api_client, API_TAGS\n\nauth = BearerToken('my_api_key')\nconfig = Configuration(auth=auth)\nadmins = create_api_client(API_TAGS[\"admin\"], config)\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F0xry4n%2Fintercom-python-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F0xry4n%2Fintercom-python-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F0xry4n%2Fintercom-python-sdk/lists"}