---
name: intercom-api
description: "Intercom API skill. Use when working with Intercom for me, admins, articles. Covers 108 endpoints."
version: 1.0.0
generator: lapsh
---

# Intercom API
API version: 2.11

## Auth
Bearer bearer

## Base URL
https://api.intercom.io

## Setup
1. Set Authorization header with Bearer token
2. GET /me -- identify an admin
3. POST /articles -- create first article

## Endpoints
108 endpoints across 22 groups. See references/api-spec.lap for full details.

### Me
| Method | Path | Description |
|--------|------|-------------|
| GET | /me | Identify an admin |

### Admins
| Method | Path | Description |
|--------|------|-------------|
| PUT | /admins/{admin_id}/away | Set an admin to away |
| GET | /admins/activity_logs | List all activity logs |
| GET | /admins | List all admins |
| GET | /admins/{admin_id} | Retrieve an admin |

### Articles
| Method | Path | Description |
|--------|------|-------------|
| GET | /articles | List all articles |
| POST | /articles | Create an article |
| GET | /articles/{article_id} | Retrieve an article |
| PUT | /articles/{article_id} | Update an article |
| DELETE | /articles/{article_id} | Delete an article |
| GET | /articles/search | Search for articles |

### Help_center
| Method | Path | Description |
|--------|------|-------------|
| GET | /help_center/collections | List all collections |
| POST | /help_center/collections | Create a collection |
| GET | /help_center/collections/{collection_id} | Retrieve a collection |
| PUT | /help_center/collections/{collection_id} | Update a collection |
| DELETE | /help_center/collections/{collection_id} | Delete a collection |
| GET | /help_center/help_centers/{help_center_id} | Retrieve a Help Center |
| GET | /help_center/help_centers | List all Help Centers |

### Companies
| Method | Path | Description |
|--------|------|-------------|
| POST | /companies | Create or Update a company |
| GET | /companies | Retrieve companies |
| GET | /companies/{company_id} | Retrieve a company by ID |
| PUT | /companies/{company_id} | Update a company |
| DELETE | /companies/{company_id} | Delete a company |
| GET | /companies/{company_id}/contacts | List attached contacts |
| GET | /companies/{company_id}/segments | List attached segments for companies |
| POST | /companies/list | List all companies |
| GET | /companies/scroll | Scroll over all companies |

### Contacts
| Method | Path | Description |
|--------|------|-------------|
| POST | /contacts/{contact_id}/companies | Attach a Contact to a Company |
| GET | /contacts/{contact_id}/companies | List attached companies for contact |
| DELETE | /contacts/{contact_id}/companies/{company_id} | Detach a contact from a company |
| GET | /contacts/{contact_id}/notes | List all notes |
| POST | /contacts/{contact_id}/notes | Create a note |
| GET | /contacts/{contact_id}/segments | List attached segments for contact |
| GET | /contacts/{contact_id}/subscriptions | List subscriptions for a contact |
| POST | /contacts/{contact_id}/subscriptions | Add subscription to a contact |
| DELETE | /contacts/{contact_id}/subscriptions/{subscription_id} | Remove subscription from a contact |
| GET | /contacts/{contact_id}/tags | List tags attached to a contact |
| POST | /contacts/{contact_id}/tags | Add tag to a contact |
| DELETE | /contacts/{contact_id}/tags/{tag_id} | Remove tag from a contact |
| PUT | /contacts/{contact_id} | Update a contact |
| GET | /contacts/{contact_id} | Get a contact |
| DELETE | /contacts/{contact_id} | Delete a contact |
| POST | /contacts/merge | Merge a lead and a user |
| POST | /contacts/search | Search contacts |
| GET | /contacts | List all contacts |
| POST | /contacts | Create contact |
| POST | /contacts/{contact_id}/archive | Archive contact |
| POST | /contacts/{contact_id}/unarchive | Unarchive contact |

### Conversations
| Method | Path | Description |
|--------|------|-------------|
| POST | /conversations/{conversation_id}/tags | Add tag to a conversation |
| DELETE | /conversations/{conversation_id}/tags/{tag_id} | Remove tag from a conversation |
| GET | /conversations | List all conversations |
| POST | /conversations | Creates a conversation |
| GET | /conversations/{conversation_id} | Retrieve a conversation |
| PUT | /conversations/{conversation_id} | Update a conversation |
| POST | /conversations/search | Search conversations |
| POST | /conversations/{conversation_id}/reply | Reply to a conversation |
| POST | /conversations/{conversation_id}/parts | Manage a conversation |
| POST | /conversations/{conversation_id}/run_assignment_rules | Run Assignment Rules on a conversation |
| POST | /conversations/{conversation_id}/customers | Attach a contact to a conversation |
| DELETE | /conversations/{conversation_id}/customers/{contact_id} | Detach a contact from a group conversation |
| POST | /conversations/redact | Redact a conversation part |
| POST | /conversations/{conversation_id}/convert | Convert a conversation to a ticket |

### Data_attributes
| Method | Path | Description |
|--------|------|-------------|
| GET | /data_attributes | List all data attributes |
| POST | /data_attributes | Create a data attribute |
| PUT | /data_attributes/{data_attribute_id} | Update a data attribute |

### Events
| Method | Path | Description |
|--------|------|-------------|
| POST | /events | Submit a data event |
| GET | /events | List all data events |
| POST | /events/summaries | Create event summaries |

### Export
| Method | Path | Description |
|--------|------|-------------|
| POST | /export/content/data | Create content data export |
| GET | /export/content/data/{job_identifier} | Show content data export |
| POST | /export/cancel/{job_identifier} | Cancel content data export |

### Download
| Method | Path | Description |
|--------|------|-------------|
| GET | /download/content/data/{job_identifier} | Download content data export |

### Messages
| Method | Path | Description |
|--------|------|-------------|
| POST | /messages | Create a message |

### News
| Method | Path | Description |
|--------|------|-------------|
| GET | /news/news_items | List all news items |
| POST | /news/news_items | Create a news item |
| GET | /news/news_items/{news_item_id} | Retrieve a news item |
| PUT | /news/news_items/{news_item_id} | Update a news item |
| DELETE | /news/news_items/{news_item_id} | Delete a news item |
| GET | /news/newsfeeds/{newsfeed_id}/items | List all live newsfeed items |
| GET | /news/newsfeeds | List all newsfeeds |
| GET | /news/newsfeeds/{newsfeed_id} | Retrieve a newsfeed |

### Notes
| Method | Path | Description |
|--------|------|-------------|
| GET | /notes/{note_id} | Retrieve a note |

### Segments
| Method | Path | Description |
|--------|------|-------------|
| GET | /segments | List all segments |
| GET | /segments/{segment_id} | Retrieve a segment |

### Subscription_types
| Method | Path | Description |
|--------|------|-------------|
| GET | /subscription_types | List subscription types |

### Phone_call_redirects
| Method | Path | Description |
|--------|------|-------------|
| POST | /phone_call_redirects | Create a phone Switch |

### Tags
| Method | Path | Description |
|--------|------|-------------|
| GET | /tags | List all tags |
| POST | /tags | Create or update a tag, Tag or untag companies, Tag contacts |
| GET | /tags/{tag_id} | Find a specific tag |
| DELETE | /tags/{tag_id} | Delete tag |

### Teams
| Method | Path | Description |
|--------|------|-------------|
| GET | /teams | List all teams |
| GET | /teams/{team_id} | Retrieve a team |

### Ticket_types
| Method | Path | Description |
|--------|------|-------------|
| POST | /ticket_types/{ticket_type_id}/attributes | Create a new attribute for a ticket type |
| PUT | /ticket_types/{ticket_type_id}/attributes/{attribute_id} | Update an existing attribute for a ticket type |
| GET | /ticket_types | List all ticket types |
| POST | /ticket_types | Create a ticket type |
| GET | /ticket_types/{ticket_type_id} | Retrieve a ticket type |
| PUT | /ticket_types/{ticket_type_id} | Update a ticket type |

### Tickets
| Method | Path | Description |
|--------|------|-------------|
| POST | /tickets/{ticket_id}/reply | Reply to a ticket |
| POST | /tickets/{ticket_id}/tags | Add tag to a ticket |
| DELETE | /tickets/{ticket_id}/tags/{tag_id} | Remove tag from a ticket |
| POST | /tickets | Create a ticket |
| PUT | /tickets/{ticket_id} | Update a ticket |
| GET | /tickets/{ticket_id} | Retrieve a ticket |
| POST | /tickets/search | Search tickets |

### Visitors
| Method | Path | Description |
|--------|------|-------------|
| PUT | /visitors | Update a visitor |
| GET | /visitors | Retrieve a visitor with User ID |
| POST | /visitors/convert | Convert a visitor |

## Common Questions
Match user requests to endpoints in references/api-spec.lap. Key patterns:
- "List all me?" -> GET /me
- "List all activity_logs?" -> GET /admins/activity_logs
- "List all admins?" -> GET /admins
- "Get admin details?" -> GET /admins/{admin_id}
- "List all articles?" -> GET /articles
- "Create a article?" -> POST /articles
- "Get article details?" -> GET /articles/{article_id}
- "Update a article?" -> PUT /articles/{article_id}
- "Delete a article?" -> DELETE /articles/{article_id}
- "List all search?" -> GET /articles/search
- "List all collections?" -> GET /help_center/collections
- "Create a collection?" -> POST /help_center/collections
- "Get collection details?" -> GET /help_center/collections/{collection_id}
- "Update a collection?" -> PUT /help_center/collections/{collection_id}
- "Delete a collection?" -> DELETE /help_center/collections/{collection_id}
- "Get help_center details?" -> GET /help_center/help_centers/{help_center_id}
- "List all help_centers?" -> GET /help_center/help_centers
- "Create a company?" -> POST /companies
- "List all companies?" -> GET /companies
- "Get company details?" -> GET /companies/{company_id}
- "Update a company?" -> PUT /companies/{company_id}
- "Delete a company?" -> DELETE /companies/{company_id}
- "List all contacts?" -> GET /companies/{company_id}/contacts
- "List all segments?" -> GET /companies/{company_id}/segments
- "Create a list?" -> POST /companies/list
- "List all scroll?" -> GET /companies/scroll
- "List all notes?" -> GET /contacts/{contact_id}/notes
- "Create a note?" -> POST /contacts/{contact_id}/notes
- "List all subscriptions?" -> GET /contacts/{contact_id}/subscriptions
- "Create a subscription?" -> POST /contacts/{contact_id}/subscriptions
- "Delete a subscription?" -> DELETE /contacts/{contact_id}/subscriptions/{subscription_id}
- "List all tags?" -> GET /contacts/{contact_id}/tags
- "Create a tag?" -> POST /contacts/{contact_id}/tags
- "Delete a tag?" -> DELETE /contacts/{contact_id}/tags/{tag_id}
- "Update a contact?" -> PUT /contacts/{contact_id}
- "Get contact details?" -> GET /contacts/{contact_id}
- "Delete a contact?" -> DELETE /contacts/{contact_id}
- "Create a merge?" -> POST /contacts/merge
- "Create a search?" -> POST /contacts/search
- "Create a contact?" -> POST /contacts
- "Create a archive?" -> POST /contacts/{contact_id}/archive
- "Create a unarchive?" -> POST /contacts/{contact_id}/unarchive
- "List all conversations?" -> GET /conversations
- "Create a conversation?" -> POST /conversations
- "Get conversation details?" -> GET /conversations/{conversation_id}
- "Update a conversation?" -> PUT /conversations/{conversation_id}
- "Create a reply?" -> POST /conversations/{conversation_id}/reply
- "Create a part?" -> POST /conversations/{conversation_id}/parts
- "Create a run_assignment_rule?" -> POST /conversations/{conversation_id}/run_assignment_rules
- "Create a customer?" -> POST /conversations/{conversation_id}/customers
- "Delete a customer?" -> DELETE /conversations/{conversation_id}/customers/{contact_id}
- "Create a redact?" -> POST /conversations/redact
- "Create a convert?" -> POST /conversations/{conversation_id}/convert
- "List all data_attributes?" -> GET /data_attributes
- "Create a data_attribute?" -> POST /data_attributes
- "Update a data_attribute?" -> PUT /data_attributes/{data_attribute_id}
- "Create a event?" -> POST /events
- "List all events?" -> GET /events
- "Create a summary?" -> POST /events/summaries
- "Create a data?" -> POST /export/content/data
- "Get data details?" -> GET /export/content/data/{job_identifier}
- "Create a message?" -> POST /messages
- "List all news_items?" -> GET /news/news_items
- "Create a news_item?" -> POST /news/news_items
- "Get news_item details?" -> GET /news/news_items/{news_item_id}
- "Update a news_item?" -> PUT /news/news_items/{news_item_id}
- "Delete a news_item?" -> DELETE /news/news_items/{news_item_id}
- "List all items?" -> GET /news/newsfeeds/{newsfeed_id}/items
- "List all newsfeeds?" -> GET /news/newsfeeds
- "Get newsfeed details?" -> GET /news/newsfeeds/{newsfeed_id}
- "Get note details?" -> GET /notes/{note_id}
- "Get segment details?" -> GET /segments/{segment_id}
- "List all subscription_types?" -> GET /subscription_types
- "Create a phone_call_redirect?" -> POST /phone_call_redirects
- "Get tag details?" -> GET /tags/{tag_id}
- "List all teams?" -> GET /teams
- "Get team details?" -> GET /teams/{team_id}
- "Create a attribute?" -> POST /ticket_types/{ticket_type_id}/attributes
- "Update a attribute?" -> PUT /ticket_types/{ticket_type_id}/attributes/{attribute_id}
- "List all ticket_types?" -> GET /ticket_types
- "Create a ticket_type?" -> POST /ticket_types
- "Get ticket_type details?" -> GET /ticket_types/{ticket_type_id}
- "Update a ticket_type?" -> PUT /ticket_types/{ticket_type_id}
- "Create a ticket?" -> POST /tickets
- "Update a ticket?" -> PUT /tickets/{ticket_id}
- "Get ticket details?" -> GET /tickets/{ticket_id}
- "List all visitors?" -> GET /visitors
- "How to authenticate?" -> See Auth section above

## Response Tips
- Check response schemas in references/api-spec.lap for field details
- Paginated endpoints accept limit/offset or cursor parameters
- Create/update endpoints return the modified resource on success
- Error responses include status codes and descriptions in the spec

## References
- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

> Generated from the official API spec by [LAP](https://lap.sh)