Intercom PHP

https://github.com/intercom/intercom-php
Admin
Intercom PHP is a PHP SDK that provides convenient access to the Intercom APIs for managing customer...
Tokens:1,135,204
Snippets:6,536
Trust Score:8.3
Update:4 weeks ago
Show doc for...
Tokens:
Raw
### Direct call example using RawClient

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/api-reference/core-http.md

Shows how to instantiate `RawClient` with an authorization header and send a GET request to the Intercom API. The response body is decoded as JSON.

```php
use Intercom\Core\Client\RawClient;
use Intercom\Core\Client\HttpMethod;
use Intercom\Core\Json\JsonApiRequest;
use Intercom\Environments;

$raw = new RawClient(['headers' => ['Authorization' => 'Bearer tok']]);
$response = $raw->sendRequest(new JsonApiRequest(
    baseUrl: Environments::UsProduction->value,
    path: 'articles',
    method: HttpMethod::GET,
));
$body = json_decode($response->getBody()->getContents(), true);
```

--------------------------------

### NotesClient usage example

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/api-reference/notes-messages.md

Example of creating a note and then finding it. Uses `CreateContactNoteRequest` and `FindNoteRequest`. Catches `IntercomApiException` and prints the error code and body.

```php
use Intercom\IntercomClient;
use Intercom\Notes\Requests\CreateContactNoteRequest;
use Intercom\Notes\Requests\FindNoteRequest;
use Intercom\Exceptions\IntercomApiException;

$client = new IntercomClient('<token>');

$note = $client->notes->create(new CreateContactNoteRequest([
    'contactId' => '63...',
    'body' => 'Follow up in Q3',
    'adminId' => 5,
]));

try {
    $fetched = $client->notes->find(new FindNoteRequest(['noteId' => $note->getId()]));
} catch (IntercomApiException $e) {
    echo $e->getCode() . ': ' . $e->getBody();
}
```

--------------------------------

### Create event example

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/api-reference/events-data-attributes.md

Example of creating an event with a user ID. It uses the IntercomClient and CreateDataEventRequestWithUserId, setting eventName, createdAt, userId, and metadata.

```php
use Intercom\IntercomClient;
use Intercom\Types\CreateDataEventRequestWithUserId;

$client = new IntercomClient('<token>');

$client->events->create(new CreateDataEventRequestWithUserId([
    'eventName' => 'purchase_completed',
    'createdAt' => time(),
    'userId' => 'u-123',
    'metadata' => ['total' => 99.5],
]));
```

--------------------------------

### Install Intercom PHP SDK with Composer

Source: https://github.com/intercom/intercom-php/blob/master/README.md

Install the Intercom PHP library via Composer. Requires PHP ^8.1.

```sh
composer require intercom/intercom-php
```

--------------------------------

### Search articles using $client->articles->search()

Source: https://github.com/intercom/intercom-php/blob/master/reference.md

Searches for articles by making a GET request to https://api.intercom.io/articles/search. The example passes a SearchArticlesRequest with phrase, state, helpCenterId, and highlight parameters.

```php
$client->articles->search(
    new SearchArticlesRequest([
        'phrase' => 'Getting started',
        'state' => 'published',
        'helpCenterId' => 1,
        'highlight' => true,
    ]),
);
```

--------------------------------

### Example usage of notifyNewMessage

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/api-reference/custom-clients.md

Example of sending a new message notification using the client, including imports and response handling.

```php
use Intercom\IntercomClient;
use Intercom\CustomChannelEvents\Requests\NotifyNewMessageRequest;
use Intercom\Types\CustomChannelContact;
use Intercom\Exceptions\IntercomApiException;

$client = new IntercomClient('<token>');

$response = $client->customChannelEvents->notifyNewMessage(new NotifyNewMessageRequest([
    'eventId' => 'evt_1',
    'externalConversationId' => 'conv_9',
    'contact' => new CustomChannelContact(['type' => 'user', 'phoneNumber' => '+1415...']),
    'body' => 'Hi there',
]));
echo $response->getBody();
```

--------------------------------

### Visitors round trip example

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/api-reference/misc-clients.md

Example showing a visitors round trip: update a visitor, merge it to a contact, and output the contact ID. Uses the Visitors client and handles IntercomApiException by printing the status code and response body.

```php
use Intercom\IntercomClient;
use Intercom\Visitors\Requests\FindVisitorRequest;
use Intercom\Visitors\Requests\UpdateVisitorRequestWithUserId;
use Intercom\Visitors\Requests\MergeVisitorToContactRequest;
use Intercom\Exceptions\IntercomApiException;

$client = new IntercomClient('<token>');

try {
    $visitor = $client->visitors->update(new UpdateVisitorRequestWithUserId([
        'userId' => 'v-1',
        'name' => 'Guest',
    ]));
    $contact = $client->visitors->mergeToContact(new MergeVisitorToContactRequest([
        'type' => 'contact',
        'user' => new \Intercom\Visitors\Types\UserWithId(['id' => '63...']),
        'visitor' => new \Intercom\Visitors\Types\VisitorWithUserId(['userId' => 'v-1']),
    ]));
    echo $contact->getId();
} catch (IntercomApiException $e) {
    echo 'Status ' . $e->getCode() . ': ' . $e->getBody();
}
```

--------------------------------

### MessagesClient usage example

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/api-reference/notes-messages.md

Example of creating an in-app message using `CreateMessageRequest::inapp()`. Sets body, from (admin), and to (contact). Prints the message ID.

```php
use Intercom\IntercomClient;
use Intercom\Types\CreateMessageRequest;
use Intercom\Types\CreateMessageRequestWithInapp;
use Intercom\Types\CreateMessageRequestFrom;
use Intercom\Types\CreateMessageRequestTo;

$client = new IntercomClient('<token>');

$message = $client->messages->create(
    CreateMessageRequest::inapp(
        new CreateMessageRequestWithInapp([
            'body' => 'Welcome!',
            'from' => new CreateMessageRequestFrom(['type' => 'admin', 'id' => '5']),
            'to' => new CreateMessageRequestTo(['type' => 'contact', 'id' => '63...']),
        ]),
    ),
);
echo $message->getId();
```

--------------------------------

### list method

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/api-reference/admins.md

Retrieves all admins via GET /admins.

```php
public function list(?array $options = null): AdminList
```

--------------------------------

### GET /help_center/help_centers (client method: helpCenters->list)

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/endpoints.md

Lists all help centers.

```APIDOC
## GET /help_center/help_centers

### Description
List all help centers.

### Method
GET

### Endpoint
/help_center/help_centers

### Response
#### Success Response (200)
- A pager of help centers.
#### Response Example
{
  "data": []
}
```

--------------------------------

### Multipart upload example

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/api-reference/core-http.md

Shows how to create a `File` from a filepath, add it to a `MultipartFormData` form, and send a `MultipartApiRequest` via `RawClient`. Also demonstrates error handling when the file does not exist, printing the exception message.

```php
use Intercom\Utils\File;
use Intercom\Core\Multipart\MultipartFormData;
use Intercom\Core\Multipart\MultipartApiRequest;
use Intercom\Core\Client\HttpMethod;
use Intercom\Core\Client\RawClient;

$file = File::createFromFilepath('/tmp/report.csv', 'report.csv', 'text/csv');
$form = new MultipartFormData();
$form->addPart($file->toMultipartFormDataPart('file'));

$raw = new RawClient();
$response = $raw->sendRequest(new MultipartApiRequest(
    baseUrl: 'https://api.intercom.io',
    path: 'some/upload/endpoint',
    method: HttpMethod::POST,
    body: $form,
));

try {
    $broken = File::createFromFilepath('/does/not/exist.csv');
} catch (\Exception $e) {
    echo $e->getMessage(); // "Unable to open file /does/not/exist.csv"
}
```

--------------------------------

### list method

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/api-reference/tags.md

Lists all tags via GET /tags. No request object required.

```php
public function list(?array $options = null): TagList
```

--------------------------------

### Basic usage example

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/api-reference/tags.md

Shows how to create a tag and tag a contact using the TagsClient. Requires an IntercomClient with a token.

```php
use Intercom\IntercomClient;
use Intercom\Tags\Requests\TagContactRequest;
use Intercom\Tags\Requests\CreateOrUpdateTagRequest;

$client = new IntercomClient('<token>');

$tag = $client->tags->create(new CreateOrUpdateTagRequest(['name' => 'vip']));

$client->tags->tagContact(new TagContactRequest([
    'contactId' => '63...',
    'id' => $tag->getId(),
]));
```

--------------------------------

### GET /macros

Source: https://github.com/intercom/intercom-php/blob/master/reference.md

Lists all macros (saved replies) in the workspace, with pagination and placeholder transformation.

```APIDOC
## GET /macros

### Description
You can fetch a list of all macros (saved replies) in your workspace for use in automating responses. The macros are returned in descending order by updated_at. This endpoint uses cursor-based pagination via the `starting_after` parameter. The API transforms Intercom placeholders to a more standard XML-like format.

### Method
GET

### Endpoint
/macros

### Parameters
#### Query Parameters
- **perPage** (`?int`) - Optional - The number of results per page
- **startingAfter** (`?string`) - Optional - Base64-encoded cursor containing [updated_at, id] for pagination
- **updatedSince** (`?int`) - Optional - Unix timestamp to filter macros updated after this time

### Request Example
```php
$client->unstable->macros->listMacros(
    new ListMacrosRequest([
        'perPage' => 1,
        'startingAfter' => 'WzE3MTk0OTM3NTcuMCwgIjEyMyJd',
        'updatedSince' => 1000000,
    ]),
);
```

### Response
#### Success Response (200)
- **MacroList** - A list of macros

#### Response Example
```json
{
  "type": "list",
  "data": []
}
```
```

--------------------------------

### Search internal articles with searchInternalArticles

Source: https://github.com/intercom/intercom-php/blob/master/reference.md

Searches for internal articles via a GET request to https://api.intercom.io/internal_articles/search. Accepts an optional folderId parameter. The example uses the full client call: $client->internalArticles->searchInternalArticles().

```php
searchInternalArticles(
    new SearchInternalArticlesRequest([
        'folderId' => 'folder_id',
    ]),
);
```

--------------------------------

### Create and retrieve custom object instance

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/api-reference/custom-clients.md

Example showing creation and retrieval of custom object instances via the client.

```php
use Intercom\IntercomClient;
use Intercom\CustomObjectInstances\Requests\CreateOrUpdateCustomObjectInstanceRequest;
use Intercom\CustomObjectInstances\Requests\GetCustomObjectInstancesByIdRequest;
use Intercom\Exceptions\IntercomApiException;

$client = new IntercomClient('<token>');

$instance = $client->customObjectInstances->createCustomObjectInstances(
    new CreateOrUpdateCustomObjectInstanceRequest([
        'customObjectTypeIdentifier' => 'game',
        'body' => new \Intercom\CustomObjectInstances\Requests\CreateOrUpdateCustomObjectInstanceRequestBody([
            'name' => 'Portal 3',
            'released' => false,
        ]),
    ])
);

try {
    $byId = $client->customObjectInstances->getCustomObjectInstancesById(
        new GetCustomObjectInstancesByIdRequest([
            'customObjectTypeIdentifier' => 'game',
            'customObjectInstanceId' => $instance->getId(),
        ])
    );
} catch (IntercomApiException $e) {
    echo 'Status ' . $e->getCode() . ': ' . $e->getBody();
}
```

--------------------------------

### Retrieve internal article with retrieveInternalArticle

Source: https://github.com/intercom/intercom-php/blob/master/reference.md

Fetches details of a single internal article via a GET request to https://api.intercom.io/internal_articles/<id>. Requires an integer id parameter. The example uses the full client call: $client->unstable->internalArticles->retrieveInternalArticle().

```php
retrieveInternalArticle(
    new RetrieveInternalArticleRequest([
        'id' => 1,
    ]),
);
```

--------------------------------

### Basic usage example

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/api-reference/conversations.md

Shows how to create a conversation and then find it using the Intercom PHP SDK. Requires the IntercomClient, CreateConversationRequest, CreateConversationRequestFrom, and FindConversationRequest classes.

```php
use Intercom\IntercomClient;
use Intercom\Conversations\Requests\CreateConversationRequest;
use Intercom\Conversations\Types\CreateConversationRequestFrom;
use Intercom\Conversations\Requests\FindConversationRequest;

$client = new IntercomClient('<token>');

$message = $client->conversations->create(new CreateConversationRequest([
    'from' => new CreateConversationRequestFrom(['type' => 'contact', 'id' => '63...']),
    'body' => 'Hello from the PHP SDK',
]));

$conversation = $client->conversations->find(new FindConversationRequest([
    'conversationId' => $message->getConversationId(),
]));
```

--------------------------------

### DataExportClient::download

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/api-reference/export-clients.md

Calls GET /download/content/data/{jobIdentifier}. Requires jobIdentifier. Returns nothing.

```php
public function download(DownloadDataExportRequest $request, ?array $options = null): void
```

--------------------------------

### get

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/api-reference/legacy-sdk.md

Sends a GET request to the Intercom API.

```APIDOC
## GET /{endpoint}

### Description
Sends a GET request to the Intercom API.

### Method
GET

### Endpoint
`https://api.intercom.io/{endpoint}?{query}`

### Parameters
#### Path Parameters
- **endpoint** (string) - Required - The API endpoint path.

#### Query Parameters
- **queryParams** (array) - Optional - Query parameters to append to the URL.

### Response
#### Success Response (200)
Returns a `stdClass` object.

### Response Example
```json
{}
```
```

--------------------------------

### Example: create data attribute

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/api-reference/events-data-attributes.md

Shows how to instantiate the Intercom client and create a data attribute with a string data type and name 'plan'.

```php
use Intercom\IntercomClient;
use Intercom\Types\CreateDataAttributeRequestOne;

$client = new IntercomClient('<token>');
$attr = $client->dataAttributes->create(new CreateDataAttributeRequestOne([
    'model' => 'contact',
    'dataType' => 'string',
    'name' => 'plan',
]));
echo $attr->getId();
```

--------------------------------

### Basic usage example

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/api-reference/admins.md

Demonstrates how to identify the current admin and find a specific admin by ID.

```php
use Intercom\IntercomClient;
use Intercom\Admins\Requests\FindAdminRequest;
use Intercom\Admins\Requests\ConfigureAwayAdminRequest;

$client = new IntercomClient('<token>');

$me = $client->admins->identify();
echo $me->getAdmin()->getName();

$admin = $client->admins->find(new FindAdminRequest(['adminId' => 5]));
```

--------------------------------

### Basic usage: createContentImportSource

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/api-reference/ai-content.md

Basic usage example from the README. Creates a content import source with syncBehavior 'api' and a URL using the aiContent client.

```php
use Intercom\IntercomClient;
use Intercom\AiContent\Requests\CreateContentImportSourceRequest;

$client = new IntercomClient(token: '<token>');
$client->aiContent->createContentImportSource(
    new CreateContentImportSourceRequest([
        'syncBehavior' => 'api',
        'url' => 'https://www.example.com',
    ]),
);
```

--------------------------------

### Use legacy SDK alongside new SDK

Source: https://github.com/intercom/intercom-php/blob/master/README.md

Shows how to use the legacy SDK alongside the new SDK in a single file by importing the legacy client as Intercom\Legacy\IntercomClient. Useful during migration from the legacy SDK to the new SDK.

```php
use Intercom\IntercomClient;
use Intercom\Legacy\IntercomClient as LegacyIntercomClient;

$intercom = new IntercomClient();
$legacyClient = new LegacyIntercomClient();
```

--------------------------------

### File class methods

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/api-reference/core-http.md

Lists the constructor and methods of `Intercom\Utils\File`. `createFromFilepath` opens a file and throws exceptions on failure; `createFromString` streams a raw string; `toMultipartFormDataPart` builds a multipart part; `close` and `__destruct` close the stream.

```php
public function __construct(
    StreamInterface $stream,
    ?string $filename = null,
    ?string $contentType = null,
)
public static function createFromFilepath(
    string $filepath,
    ?string $filename = null,
    ?string $contentType = null,
): File
public static function createFromString(
    string $content,
    ?string $filename,
    ?string $contentType = null,
): File
public function toMultipartFormDataPart(string $name, ?string $contentType = null): MultipartFormDataPart
public function close(): void
public function __destruct()
```

--------------------------------

### Get a ticket type with $client->ticketTypes->get()

Source: https://github.com/intercom/intercom-php/blob/master/reference.md

Fetches the details of a single ticket type. The 'ticketTypeId' parameter is the unique identifier for the ticket type given by Intercom.

```php
$client->ticketTypes->get(
    new FindTicketTypeRequest([
        'ticketTypeId' => 'ticket_type_id',
    ]),
);
```

--------------------------------

### Create Content Import Source with IntercomClient

Source: https://github.com/intercom/intercom-php/blob/master/README.md

Instantiate the Intercom client with a token and call the AI content import source creation endpoint. Replace '<token>' with your actual token.

```php
<?php

namespace Example;

use Intercom\IntercomClient;
use Intercom\AiContent\Requests\CreateContentImportSourceRequest;

$client = new IntercomClient(
    token: '<token>',
);
$client->aiContent->createContentImportSource(
    new CreateContentImportSourceRequest([
        'syncBehavior' => 'api',
        'url' => 'https://www.example.com',
    ]),
);

```

--------------------------------

### GET /internal_articles/search

Source: https://github.com/intercom/intercom-php/blob/master/reference.md

Searches for internal articles.

```APIDOC
## GET /internal_articles/search

### Description
You can search for internal articles by making a GET request to `https://api.intercom.io/internal_articles/search`.

### Method
GET

### Endpoint
`https://api.intercom.io/internal_articles/search`

### Parameters
#### Query Parameters
- **folderId** (string) - Optional - The ID of the folder to search in.

### Response
#### Success Response (200)
- **InternalArticleSearchResponse** - The search results.

### Response Example
```json
{
  "type": "list",
  "data": []
}
```
```

--------------------------------

### Client configuration and per-call overrides

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/configuration.md

Shows how to configure the client with base URL and custom headers, and then override retries and timeout for a specific call.

```php
use Intercom\IntercomClient;
use Intercom\Environments;

// Client-level configuration
$client = new IntercomClient(
    token: '<token>',
    options: [
        'baseUrl' => Environments::EuProduction->value,
        'headers' => ['X-Custom-Header' => 'value'],
        'client'  => new \GuzzleHttp\Client(['timeout' => 5.0]),
    ],
);

// Per-call overrides
$client->aiContent->createContentImportSource(
    new CreateContentImportSourceRequest(['syncBehavior' => 'api', 'url' => 'https://example.com']),
    options: [
        'maxRetries' => 0,     // disable retries for this call
        'timeout' => 3.0,      // 3 second timeout
    ],
);
```

--------------------------------

### Round-trip example with Article

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/api-reference/core-json.md

Shows serializing an Article to JSON, deserializing back, and accessing unknown fields via getAdditionalProperties().

```php
use Intercom\Articles\Types\Article;

$json = $article->toJson();          // string
$copy = Article::fromJson($json);    // Article
$extra = $copy->getAdditionalProperties(); // unknown response fields
```

--------------------------------

### GET /internal_articles

Source: https://github.com/intercom/intercom-php/blob/master/reference.md

Fetches a list of all internal articles.

```APIDOC
## GET /internal_articles

### Description
You can fetch a list of all internal articles by making a GET request to `https://api.intercom.io/internal_articles`.

### Method
GET

### Endpoint
`https://api.intercom.io/internal_articles`

### Response
#### Success Response (200)
- **InternalArticleList** - The list of internal articles.

### Response Example
```json
{
  "type": "list",
  "data": []
}
```
```

--------------------------------

### GET /companies/{companyId}

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/endpoints.md

Fetches a company by its ID.

```APIDOC
## GET /companies/{companyId}

### Description
Finds a company by its ID. 

### Method
GET

### Endpoint
/companies/{companyId}

### Parameters
#### Path Parameters
- **companyId** (string) - Required - The ID of the company

### Response
#### Success Response (200)
- **Company** - The company object

### Response Example
No example provided.
```

--------------------------------

### List ticket states with $client->ticketStates->listTicketStates()

Source: https://github.com/intercom/intercom-php/blob/master/reference.md

Returns a list of all ticket states for a workspace.

```php
$client->ticketStates->listTicketStates();
```

--------------------------------

### GET /calls

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/endpoints.md

Lists calls with pagination support.

```APIDOC
## GET /calls

### Description
Lists calls, with optional pagination. 

### Method
GET

### Endpoint
/calls

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page number for pagination
- **per_page** (integer) - Optional - Number of results per page

### Response
#### Success Response (200)
- **CallList** - List of calls

### Response Example
No example provided.
```

--------------------------------

### IntercomClient with environment token and custom options

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/api-reference/intercom-client.md

Initialization using the INTERCOM_API_KEY environment variable, custom EU production base URL, and a custom Guzzle client with timeout. Includes error handling for API failures.

```php
use Intercom\IntercomClient;
use Intercom\Environments;
use GuzzleHttp\Client;

$client = new IntercomClient(options: [
    'baseUrl' => Environments::EuProduction->value,
    'timeout' => 5.0,
    'client' => new Client(['timeout' => 5.0]),
]);

try {
    $client->articles->find(...);
} catch (\Exception $e) { // IntercomApiException extends IntercomException extends \Exception
    // handle auth/missing-token or API failure
}
```

--------------------------------

### GET /admins

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/endpoints.md

Lists all admins in the Intercom workspace.

```APIDOC
## GET /admins

### Description
List all admins in the workspace.

### Method
GET

### Endpoint
/admins

### Response
#### Success Response (200)
- **AdminList** (AdminList) - List of admins.

#### Response Example
{}
```

--------------------------------

### HelpCentersClient find and list methods

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/api-reference/misc-clients.md

Provides find and list operations for help centers. find requires a FindHelpCenterRequest with helpCenterId; list uses offset pagination with optional page and perPage query parameters.

```php
public function find(FindHelpCenterRequest $request, ?array $options = null): HelpCenter
public function list(ListHelpCentersRequest $request = new ListHelpCentersRequest(), ?array $options = null): Pager   // HelpCenterList via private _list, offset pager
```

--------------------------------

### List all tags with $client->tags->list

Source: https://github.com/intercom/intercom-php/blob/master/reference.md

Fetches a list of all tags for a given workspace. Returns a TagList.

```php
$client->tags->list();
```

--------------------------------

### GET /tickets/{ticketId}

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/api-reference/tickets.md

Retrieves a ticket by its ID.

```APIDOC
## GET /tickets/{ticketId}

### Description
Retrieves a ticket by its ID.

### Method
GET

### Endpoint
/tickets/{ticketId}

### Parameters
#### Path Parameters
- **ticketId** (string) - Required - The ID of the ticket to retrieve.

### Request Example
GET /tickets/ticket_123

### Response
#### Success Response (200)
- **Ticket** - The ticket object, or null if not found.

#### Response Example
{
  "id": "ticket_123",
  "ticketTypeId": "ticket_type_123",
  "contacts": [
    {
      "id": "contact_123"
    }
  ]
}
```

--------------------------------

### GET /articles/search

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/api-reference/articles.md

Searches articles with optional filters.

```APIDOC
## GET /articles/search

### Description
Searches articles with optional filters.

### Method
GET

### Endpoint
`/articles/search`

### Parameters
#### Query Parameters
- **phrase** (string) - Optional - Search phrase.
- **state** (string) - Optional - Article state filter.
- **help_center_id** (string) - Optional - Help center ID filter.
- **highlight** (boolean) - Optional - Whether to highlight matches.

### Response
#### Success Response (200)
- **results** (ArticleSearchResponse) - Search results.

### Errors
- `IntercomException`
- `IntercomApiException`
```

--------------------------------

### Visitors Round Trip Example

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/api-reference/misc-clients.md

Demonstrates updating a visitor, merging a visitor to a contact, and handling exceptions using the Intercom PHP SDK.

```APIDOC
## Visitors Round Trip Example

### Description
Demonstrates updating a visitor, merging a visitor to a contact, and handling exceptions using the Intercom PHP SDK.

### Code Example
```php
use Intercom\IntercomClient;
use Intercom\Visitors\Requests\FindVisitorRequest;
use Intercom\Visitors\Requests\UpdateVisitorRequestWithUserId;
use Intercom\Visitors\Requests\MergeVisitorToContactRequest;
use Intercom\Exceptions\IntercomApiException;

$client = new IntercomClient('<token>');

try {
    $visitor = $client->visitors->update(new UpdateVisitorRequestWithUserId([
        'userId' => 'v-1',
        'name' => 'Guest',
    ]));
    $contact = $client->visitors->mergeToContact(new MergeVisitorToContactRequest([
        'type' => 'contact',
        'user' => new \Intercom\Visitors\Types\UserWithId(['id' => '63...']),
        'visitor' => new \Intercom\Visitors\Types\VisitorWithUserId(['userId' => 'v-1']),
    ]));
    echo $contact->getId();
} catch (IntercomApiException $e) {
    echo 'Status ' . $e->getCode() . ': ' . $e->getBody();
}
```
```

--------------------------------

### GET /ticket_types

Source: https://github.com/intercom/intercom-php/blob/master/reference.md

Retrieves a list of all ticket types for a workspace.

```APIDOC
## GET /ticket_types

### Description
You can get a list of all ticket types for a workspace.

### Method
GET

### Endpoint
/ticket_types

### Response
#### Success Response (200)
- **TicketTypeList** - A list of ticket types.

#### Response Example
```json
{
  "type": "list",
  "data": []
}
```
```

--------------------------------

### GET /ticket_states

Source: https://github.com/intercom/intercom-php/blob/master/reference.md

Retrieves a list of all ticket states for a workspace.

```APIDOC
## GET /ticket_states

### Description
You can get a list of all ticket states for a workspace.

### Method
GET

### Endpoint
/ticket_states

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **data** (array) - List of ticket states

#### Response Example
{
  "data": []
}
```

--------------------------------

### Basic IntercomClient initialization

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/api-reference/intercom-client.md

Basic initialization with a hardcoded token. Access a domain client via a public property, e.g., helpCenters.

```php
use Intercom\IntercomClient;

$client = new IntercomClient(
    token: 'your_access_token',
);

$page = $client->helpCenters; // HelpCentersClient
```

--------------------------------

### GET /teams

Source: https://github.com/intercom/intercom-php/blob/master/reference.md

This will return a list of team objects for the App.

```APIDOC
## [GET] /teams

### Description
This will return a list of team objects for the App.

### Method
GET

### Endpoint
/teams

### Parameters
None

### Request Example
```php
$client->teams->list();
```

### Response
#### Success Response (200)
- **teams** (array of Team) - List of team objects

#### Response Example
```json
{
  "teams": []
}
```
```

--------------------------------

### Configure away mode with error handling

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/api-reference/admins.md

Demonstrates how to configure away mode for an admin while catching potential IntercomApiException errors.

```php
use Intercom\Exceptions\IntercomApiException;

try {
    $client->admins->away(new ConfigureAwayAdminRequest([
        'adminId' => 5,
        'awayModeEnabled' => true,
        'awayModeReassign' => false,
    ]));
} catch (IntercomApiException $e) {
    echo 'Status ' . $e->getCode() . ': ' . $e->getBody();
}
```

--------------------------------

### GET /jobs/{id}

Source: https://github.com/intercom/intercom-php/blob/master/reference.md

Retrieve the status of job execution.

```APIDOC
## [GET] /jobs/{id}

### Description
Retrieve the status of job execution.

### Method
GET

### Endpoint
/jobs/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier for the job which is given by Intercom

### Request Example
```php
$client->unstable->jobs->status(
    new JobsStatusRequest([
        'id' => 'id',
    ]),
);
```

### Response
#### Success Response (200)
- **Jobs** - The status of the job execution.

#### Response Example
```json
{
  "job": {}
}
```
```

--------------------------------

### GET /tags/{tagId}

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/endpoints.md

Retrieves a single tag by its identifier.

```APIDOC
## GET /tags/{tagId}

### Description
Finds a tag by its ID.

### Method
GET

### Endpoint
/tags/{tagId}

### Parameters
#### Path Parameters
- **tagId** (string) - Required - The identifier of the tag to retrieve.

#### Request Body
- **FindTagRequest** - Required - The request containing the tag ID.

### Response
#### Success Response (200)
- **Tag** - The requested tag object.
```

--------------------------------

### $client->news->items->list() - List news items

Source: https://github.com/intercom/intercom-php/blob/master/reference.md

Fetches a list of all news items. Call without arguments.

```php
  $client->news->items->list();

```

--------------------------------

### Basic contact creation and find (PHP)

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/api-reference/contacts.md

Creates a contact with an email and custom attributes, prints the new contact ID, then finds the contact by ID. Requires an Intercom access token and the intercom-php SDK.

```php
use Intercom\IntercomClient;
use Intercom\Types\CreateContactRequestWithEmail;
use Intercom\Contacts\Requests\FindContactRequest;

$client = new IntercomClient('<token>');

$created = $client->contacts->create(new CreateContactRequestWithEmail([
    'email' => 'jane@example.com',
    'name' => 'Jane',
    'customAttributes' => ['plan' => 'pro'],
]));
echo $created->getContact()->getId();

$found = $client->contacts->find(new FindContactRequest(['contactId' => $created->getContact()->getId()]));
```

--------------------------------

### GET /companies/scroll

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/endpoints.md

Scrolls through companies using a cursor-based pagination.

```APIDOC
## GET /companies/scroll

### Description
Scrolls through companies with pagination. 

### Method
GET

### Endpoint
/companies/scroll

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page number
- **per_page** (integer) - Optional - Items per page
- **scroll_param** (string) - Optional - Scroll parameter

### Response
#### Success Response (200)
- **Pager<Company>** - Paginated list of companies

### Response Example
No example provided.
```

--------------------------------

### Create a ticket and poll the async job

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/api-reference/tickets.md

This example creates a ticket using the Intercom PHP client and prints the ticket ID. It uses the CreateTicketRequest with a ticket type ID, a contact email, and skipNotifications set to true.

```php
use Intercom\IntercomClient;
use Intercom\Tickets\Requests\CreateTicketRequest;
use Intercom\Tickets\Requests\EnqueueCreateTicketRequest;
use Intercom\Types\CreateTicketRequestContactsItemEmail;
use Intercom\Jobs\Requests\JobsStatusRequest;

$client = new IntercomClient('<token>');

$ticket = $client->tickets->create(new CreateTicketRequest([
    'ticketTypeId' => 'tt_123',
    'contacts' => [
        new CreateTicketRequestContactsItemEmail(['email' => 'jane@example.com']),
    ],
    'skipNotifications' => true,
]));
echo $ticket->getId();
```

--------------------------------

### GET /companies

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/endpoints.md

Retrieves a list of companies with optional filters.

```APIDOC
## GET /companies

### Description
Retrieves companies, optionally filtered by company_id, name, website, or remote_created_at. 

### Method
GET

### Endpoint
/companies

### Parameters
#### Query Parameters
- **company_id** (string) - Optional - Company ID filter
- **name** (string) - Optional - Company name filter
- **website** (string) - Optional - Company website filter
- **remote_created_at** (string) - Optional - Remote created date filter

### Response
#### Success Response (200)
- **CompaniesRetrieveResponse** - List of companies

### Response Example
No example provided.
```

--------------------------------

### GET /calls/{callId}/recording

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/endpoints.md

Retrieves a call recording.

```APIDOC
## GET /calls/{callId}/recording

### Description
Retrieves the recording of a call. 

### Method
GET

### Endpoint
/calls/{callId}/recording

### Parameters
#### Path Parameters
- **callId** (string) - Required - The ID of the call

### Response
#### Success Response (200)
- **void** - No content

### Response Example
No example provided.
```

--------------------------------

### List Help Centers with ListHelpCentersRequest

Source: https://github.com/intercom/intercom-php/blob/master/reference.md

Lists all Help Centers. Supports optional pagination parameters: page (defaults to first page) and perPage (defaults to 15).

```php
$client->helpCenters->list(
    new ListHelpCentersRequest([]),
);
```

--------------------------------

### Basic usage of showCall

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/api-reference/calls.md

Basic usage example showing how to retrieve a call by its ID and output its duration.

```php
use Intercom\IntercomClient;
use Intercom\Calls\Requests\ShowCallRequest;

$client = new IntercomClient('<token>');
$call = $client->calls->showCall(new ShowCallRequest(['callId' => 'call_123']));
echo $call->getDuration();
```

--------------------------------

### GET /calls/{callId}

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/endpoints.md

Fetches a single call by its ID.

```APIDOC
## GET /calls/{callId}

### Description
Shows a specific call by its ID. 

### Method
GET

### Endpoint
/calls/{callId}

### Parameters
#### Path Parameters
- **callId** (string) - Required - The ID of the call

### Request Example
No request body required.

### Response
#### Success Response (200)
- **Call** - The call object

### Response Example
No example provided.
```

--------------------------------

### List teams with $client->teams->list()

Source: https://github.com/intercom/intercom-php/blob/master/reference.md

Returns a list of team objects for the App.

```php
$client->teams->list();
```

--------------------------------

### list

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/api-reference/tags.md

Lists all tags. Sends a GET request to /tags.

```APIDOC
## GET /tags

### Description
Lists all tags.

### Method
GET

### Endpoint
/tags

### Response
#### Success Response (200)
- **type** (string) - Always 'tag.list'.
- **data** (array of Tag) - List of tags.
- **pages** (object) - Pagination info.
- **totalCount** (integer) - Total number of tags.

#### Response Example
{
  "type": "tag.list",
  "data": [
    {
      "id": "tag_id",
      "workspaceId": "workspace_id",
      "name": "vip",
      "type": "tag"
    }
  ],
  "pages": {},
  "totalCount": 1
}
```

--------------------------------

### GET /jobs/status/{jobId}

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/api-reference/misc-clients.md

Retrieves the status of an asynchronous job.

```APIDOC
## GET /jobs/status/{jobId}

### Description
Retrieves the status of an asynchronous job.

### Method
GET

### Endpoint
/jobs/status/{jobId}

### Parameters
#### Path Parameters
- **jobId** (string) - Required - The ID of the job to check.

### Response
#### Success Response (200)
- **id** (string) - The job ID.
- **type** (string, nullable) - The type of the job.
- **url** (string, nullable) - The URL to the job resource.
- **status** (JobsStatus enum, nullable) - The status of the job. Possible values: `pending`, `success`, `failed`.
- **resourceType** (string, nullable) - The type of the resource being processed.
- **resourceId** (string, nullable) - The ID of the resource being processed.
- **resourceUrl** (string, nullable) - The URL to the resource being processed.

#### Response Example
```json
{
  "id": "job_123",
  "type": "job",
  "url": "https://api.intercom.io/jobs/status/job_123",
  "status": "success",
  "resource_type": "ticket",
  "resource_id": "ticket_456",
  "resource_url": "https://api.intercom.io/tickets/ticket_456"
}
```
```

--------------------------------

### RawClient::__construct

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/api-reference/core-http.md

Creates a new RawClient instance with optional configuration for base URL, HTTP client, and default headers.

```APIDOC
## RawClient::__construct

### Description
Creates a new RawClient instance with optional configuration for base URL, HTTP client, and default headers.

### Method
Constructor

### Signature
```php
public function __construct(
    public readonly ?array $options = null,
)
```

### Parameters
- **$options** (?array{ baseUrl?: string, client?: ClientInterface, headers?: array<string,string> }) - Optional - Configuration array. `$options['client']` — any Guzzle `ClientInterface` (defaults to a Guzzle `Client` with `HandlerStack` containing `RetryMiddleware`); `$options['headers']` — default headers merged on every request.

### Response
No return value.
```

--------------------------------

### $client->helpCenters->list($request) -> HelpCenterList

Source: https://github.com/intercom/intercom-php/blob/master/reference.md

Lists all Help Centers. Supports pagination with page and perPage parameters.

```APIDOC
## $client->helpCenters->list($request) -> HelpCenterList

### Description
You can list all Help Centers by making a GET request to `https://api.intercom.io/help_center/help_centers`.

### Method
GET

### Endpoint
https://api.intercom.io/help_center/help_centers

### Parameters
#### Query Parameters
- **page** (?int) - Optional - The page of results to fetch. Defaults to first page
- **perPage** (?int) - Optional - How many results to display per page. Defaults to 15

### Request Example
```php
$client->helpCenters->list(
    new ListHelpCentersRequest([]),
);
```

### Response
#### Success Response (200)
- **HelpCenterList** (object) - A list of Help Centers.

#### Response Example
(HelpCenterList object)
```

--------------------------------

### GET /ip_allowlist

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/api-reference/misc-clients.md

Retrieves the IP allowlist configuration for the workspace.

```APIDOC
## GET /ip_allowlist

### Description
Retrieves the IP allowlist configuration for the workspace.

### Method
GET

### Endpoint
/ip_allowlist

### Parameters
#### Query Parameters
- **options** (?array) - Optional - Additional request options.

### Response
#### Success Response (200)
- **IpAllowlist** (Intercom\IpAllowlist\IpAllowlist) - The IP allowlist configuration.

#### Response Example
```json
{
  "enabled": true,
  "ip_allowlist": ["192.168.1.1"]
}
```
```

--------------------------------

### listInternalArticles

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/api-reference/misc-clients.md

Lists internal articles. Corresponds to GET /internal_articles.

```APIDOC
## GET /internal_articles

### Description
Lists internal articles.

### Method
GET

### Endpoint
/internal_articles

### Parameters
#### Query Parameters
- **options** (array) - Optional - Additional request options.

### Response
#### Success Response (200)
- **InternalArticleList** - The list of internal articles.

#### Response Example
```json
{
  "type": "list",
  "data": []
}
```
```

--------------------------------

### Create a ticket and poll the async job

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/api-reference/tickets.md

Example of creating a ticket using the Intercom PHP SDK and retrieving the ticket ID.

```APIDOC
## Create a ticket

### Description
Creates a new ticket in Intercom using the provided request data.

### Method
POST

### Endpoint
/tickets

### Parameters
#### Request Body
- **ticketTypeId** (string) - Required - The ID of the ticket type.
- **contacts** (array) - Required - List of contact objects, each with an email.
- **skipNotifications** (boolean) - Optional - Whether to skip notifications.

### Request Example
```php
use Intercom\IntercomClient;
use Intercom\Tickets\Requests\CreateTicketRequest;
use Intercom\Tickets\Requests\EnqueueCreateTicketRequest;
use Intercom\Types\CreateTicketRequestContactsItemEmail;
use Intercom\Jobs\Requests\JobsStatusRequest;

$client = new IntercomClient('<token>');

$ticket = $client->tickets->create(new CreateTicketRequest([
    'ticketTypeId' => 'tt_123',
    'contacts' => [
        new CreateTicketRequestContactsItemEmail(['email' => 'jane@example.com']),
    ],
    'skipNotifications' => true,
]));
echo $ticket->getId();
```

### Response
#### Success Response (200)
- **id** (string) - The ID of the created ticket.

#### Response Example
```json
{
  "id": "ticket_123"
}
```
```

--------------------------------

### $client->unstable->aiContent->listContentImportSources()

Source: https://github.com/intercom/intercom-php/blob/master/reference.md

Retrieves a list of all content import sources for a workspace.

```APIDOC
## $client->unstable->aiContent->listContentImportSources()

### Description
You can retrieve a list of all content import sources for a workspace.

### Method
GET

### Endpoint
/ai_content/content_import_sources

### Response
#### Success Response (200)
- **ContentImportSourcesList** - The list of content import sources.

#### Response Example
{
  "type": "list",
  "data": []
}
```

--------------------------------

### GET /contacts/{contactId}

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/api-reference/contacts.md

Finds a contact by its unique identifier.

```APIDOC
## [GET] /contacts/{contactId}

### Description
Finds a contact by its unique identifier.

### Method
GET

### Endpoint
/contacts/{contactId}

### Parameters
#### Path Parameters
- **contactId** (string) - Required - The unique identifier of the contact.

### Request Example
```php
use Intercom\IntercomClient;
use Intercom\Contacts\Requests\FindContactRequest;

$client = new IntercomClient('<token>');
$found = $client->contacts->find(new FindContactRequest(['contactId' => $created->getContact()->getId()]));
```

### Response
#### Success Response (200)
- **contact** (Contact) - The found contact object.

#### Response Example
```php
echo $found->getContact()->getId();
```
```

--------------------------------

### retrieveHelpCenter

Source: https://github.com/intercom/intercom-php/blob/master/reference.md

Fetches the details of a help center by its ID.

```APIDOC
## GET /help_center/{id}

### Description
You can fetch the details of a single help center by making a GET request to `https://api.intercom.io/help_center/<id>`.

### Method
GET

### Endpoint
/help_center/{id}

### Parameters
#### Path Parameters
- **id** (int) - Required - The unique identifier for the help center.

### Request Example
```php
$client->unstable->helpCenter->retrieveHelpCenter(
    new RetrieveHelpCenterRequest([
        'id' => 1,
    ]),
);
```

### Response
#### Success Response (200)
Returns a HelpCenter object.

#### Response Example
```json
{
  "type": "help_center",
  "id": "1",
  "name": "Example Help Center"
}
```
```

--------------------------------

### GET /articles/{articleId}

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/api-reference/articles.md

Fetches a single article by its ID.

```APIDOC
## GET /articles/{articleId}

### Description
Fetches a single article by its ID.

### Method
GET

### Endpoint
`/articles/{articleId}`

### Parameters
#### Path Parameters
- **articleId** (string) - Required - The ID of the article to retrieve.

### Response
#### Success Response (200)
- **article** (Article) - The requested article.

### Errors
- `IntercomException`
- `IntercomApiException`
```

--------------------------------

### Legacy IntercomClient constructor and SDK_VERSION

Source: https://github.com/intercom/intercom-php/blob/master/_autodocs/api-reference/legacy-sdk.md

Defines the legacy SDK version constant and the constructor signature. The constructor accepts an app ID or token, an optional password for Basic auth, and extra request headers. When the password is set, HTTP Basic authentication is used; otherwise Bearer authentication is used.

```php
const SDK_VERSION = '4.4.0';

public function __construct(string $appIdOrToken, ?string $password = null, array $extraRequestHeaders = [])
```
Tokens:
Raw