The intercom API reference.
URL https://developers.intercom.com
License MIT
The intercom API reference.
Admins are teammate accounts that have access to a workspace.
Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.
Identifies if this admin has a paid inbox seat to restrict/allow features that require them.
This object represents the avatar associated with the admin.
Image for the associated team or teammate
{ "type": "admin", "id": "1295", "name": "Joe Examplee", "email": "wash@example.com", "job_title": "Philosopher", "away_mode_enabled": false, "away_mode_reassign": false, "has_inbox_seat": true, "team_ids": [ 814865 ], "avatar": "https://picsum.photos/200/300", "team_priority_level": { "primary_team_ids": [ … ], "secondary_team_ids": [ … ] } }
You can view the currently authorised admin along with the embedded app object (a "workspace" in legacy terminology).
🚧 Single Sign On
If you are building a custom "Log in with Intercom" flow for your site, and you call the
/meendpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk.
curl -i -X GET \ https://api.intercom.io/me \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Intercom-Version: Unstable'
Successful response
Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.
Identifies if this admin has a paid inbox seat to restrict/allow features that require them.
This is a list of ids of the teams that this admin is part of.
{ "type": "admin", "id": "991266830", "email": "admin1@email.com", "name": "Ciaran1 Lee", "email_verified": true, "app": { "type": "app", "id_code": "this_is_an_id1_that_should_be_at_least_40", "name": "MyApp 1", "created_at": 1727856792, "secure": false, "identity_verification": false, "timezone": "America/Los_Angeles", "region": "US" }, "avatar": { "type": "avatar", "image_url": "https://static.intercomassets.com/assets/default-avatars/admins/128.png" }, "has_inbox_seat": true }
Set to "true" to change the status of the admin to away.
curl -i -X PUT \ 'https://api.intercom.io/admins/{id}/away' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -H 'Intercom-Version: Unstable' \ -d '{ "away_mode_enabled": true, "away_mode_reassign": true }'
Successful response
Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.
Identifies if this admin has a paid inbox seat to restrict/allow features that require them.
This object represents the avatar associated with the admin.
Image for the associated team or teammate
{ "type": "admin", "id": "991266831", "name": "Ciaran2 Lee", "email": "admin2@email.com", "away_mode_enabled": true, "away_mode_reassign": true, "has_inbox_seat": true, "team_ids": [] }
curl -i -X GET \ 'https://api.intercom.io/admins/activity_logs?created_at_after=string&created_at_before=string' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Intercom-Version: Unstable'
Successful response
String representing the object's type. Always has the value activity_log.list.
Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed.
{ "type": "activity_log.list", "pages": { "type": "pages", "next": null, "page": 1, "per_page": 20, "total_pages": 1 }, "activity_logs": [ { … }, { … } ] }
curl -i -X GET \ https://api.intercom.io/admins \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Intercom-Version: Unstable'
{ "type": "admin.list", "admins": [ { … } ] }
curl -i -X GET \ 'https://api.intercom.io/admins/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Intercom-Version: Unstable'
Admin found
Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.
Identifies if this admin has a paid inbox seat to restrict/allow features that require them.
This object represents the avatar associated with the admin.
Image for the associated team or teammate
{ "type": "admin", "id": "991266839", "name": "Ciaran9 Lee", "email": "admin9@email.com", "away_mode_enabled": false, "away_mode_reassign": false, "has_inbox_seat": true, "team_ids": [] }
With the AI Content APIs, you can create and manage External Pages and Content Import Sources for your Fin Content Library.
Â
External Pages are pages that you want Fin to be able to answer questions about. The API for External Pages is a great way to ingest into your Fin Content Library pages that are not publicly accessible and hence can't be crawled by Intercom.
Â
Content Import Sources are the sources of those pages, and they are used to determine the default audience for the pages (configured via the UI). You should create a Content Import Source for each source of External Pages that you want to ingest into your Fin Content Library.
Â
You can then iterate through the content from that source via its API and POST it to the External Pages endpoint. That endpoint has an external_id parameter which allows you to specify the identifier from the source. The endpoint will then either create a new External Page or update an existing one as appropriate.",