# Gladly API API

> Gladly API API on Apizie: 68 endpoints (Send SMS, Receive Custom Channel messages, Update message status, Get conversation, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/business:gladly/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `business:gladly`
- Category: Business
- Status: byok
- Source: https://gladly.com
- Page: https://apizie.tech/api/business/gladly
- OpenAPI: https://apizie.tech/api/business/gladly/openapi.json

# Introducing the Gladly API At Gladly, we believe that customer service is best when it's a conversation. That means more than just helping customers with one-off questions or issues: it's about making them feel…

## Endpoints

### Send SMS
`POST https://apizie.tech/v1/business:gladly/communications-send-sms` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Receive Custom Channel messages
`POST https://apizie.tech/v1/business:gladly/communications-receive-custom-channel-messages` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customChannelId | string | yes | The ID of the Custom Channel. To find the Custom Channel ID, you must open the overflow menu of a Custom Channel Entry Point and select… |
| body | object | yes | JSON request body |

### Update message status
`POST https://apizie.tech/v1/business:gladly/communications-update-message-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customChannelId | string | yes | The ID of the Custom Channel. To find the Custom Channel ID, you must open the overflow menu of a Custom Channel Entry Point and select… |
| messageId | string | yes | The id of message updated |
| body | object | yes | JSON request body |

### Get conversation
`GET https://apizie.tech/v1/business:gladly/conversations-get-metadata` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversationId | string | yes | Id of the conversation to get |

### Update conversation
`POST https://apizie.tech/v1/business:gladly/conversations-update-assignee-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversationId | string | yes | Id of the conversation |
| body | object | yes | JSON request body |

### Create item
`POST https://apizie.tech/v1/business:gladly/conversations-create-customer-item` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get item
`GET https://apizie.tech/v1/business:gladly/conversations-get-item` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| itemId | string | yes | id of the conversation item |

### Delete item
`POST https://apizie.tech/v1/business:gladly/conversations-delete-item` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| itemId | string | yes | Id of the item to be deleted. |

### Get media
`GET https://apizie.tech/v1/business:gladly/conversations-get-recording` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| itemId | string | yes | id of the conversation item |

### Create item for customer
`POST https://apizie.tech/v1/business:gladly/conversations-create-customer-item-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | Id of the customer associated with this item. You can look up the id using the [Find customers](index.html#tag/Customers) API. |
| body | object | no | JSON request body |

### Delete item for customer
`POST https://apizie.tech/v1/business:gladly/conversations-delete-customer-item` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | Id of the customer associated with this item. You can look up the id using the [Find customers](index.html#tag/Customers) API. |
| itemId | string | yes | Id of the item to be deleted. |

### List items in conversation
`GET https://apizie.tech/v1/business:gladly/conversations-list-items-in-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversationId | string | yes | Id of the conversation to get the timeline for |

### Add topic
`POST https://apizie.tech/v1/business:gladly/conversations-add-topic-to-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversationId | string | yes | Id of the conversation. |
| body | object | yes | JSON request body |

### Delete topic
`POST https://apizie.tech/v1/business:gladly/conversations-delete-topic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversationId | string | yes | Id of the conversation. |
| topicId | string | yes | Id of topic to be deleted from conversation. |

### Add or Remove Freeform topic
`POST https://apizie.tech/v1/business:gladly/conversations-add-freeform-topics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | Id of the customer. |
| conversationId | string | yes | Id of the conversation. |
| body | object | yes | JSON request body |

### Add note
`POST https://apizie.tech/v1/business:gladly/conversations-add-note-to-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversationId | string | yes | Id of the conversation. |
| body | object | no | JSON request body |

### Get note
`GET https://apizie.tech/v1/business:gladly/conversations-get-note` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversationId | string | yes | id of the conversation |
| noteId | string | yes | id of the note |

### Reply to message
`POST https://apizie.tech/v1/business:gladly/conversations-send-response` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| itemId | string | yes | id of the conversation item |
| body | object | no | JSON request body |

### Redact conversation item
`POST https://apizie.tech/v1/business:gladly/conversations-redact-conversation-item` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| itemId | string | yes | id of the conversation item |
| body | object | no | JSON request body |

### Get Automation Session
`GET https://apizie.tech/v1/business:gladly/message-automation-get-session` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| sessionId | string | yes | The id of the automation session. |

### Get Automation Messages
`GET https://apizie.tech/v1/business:gladly/message-automation-get-session-messages` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| sessionId | string | yes | Id of the automation session. |

### Send Outbound Automation Message
`POST https://apizie.tech/v1/business:gladly/message-automation-outbound-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| sessionId | string | yes | Id of the automation session. |
| body | object | yes | JSON request body |

### Get Automation Message
`GET https://apizie.tech/v1/business:gladly/message-automation-get-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| sessionId | string | yes | Id of the automation session. |
| messageId | string | yes | Id of the message. |

### Agent Handoff
`POST https://apizie.tech/v1/business:gladly/message-automation-handoff-session-to-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| sessionId | string | yes | Id of the automation session. |
| body | object | yes | JSON request body |

### Close Automation Session
`POST https://apizie.tech/v1/business:gladly/message-automation-close-session` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| sessionId | string | yes | Id of the automation session. |
| body | object | yes | JSON request body |

### Create task
`POST https://apizie.tech/v1/business:gladly/tasks-customer-timeline` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### List tasks
`GET https://apizie.tech/v1/business:gladly/tasks-get-customer-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | Id of the customer whose tasks you'd like to view. |
| status | string | no | Fetch tasks with the provided status. |

### Create task for customer
`POST https://apizie.tech/v1/business:gladly/tasks-create-customer-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | Id of the customer associated with the task to create. You can look up the id using the [Find customers](index.html#tag/Customers) API. |
| body | object | no | JSON request body |

### Get task
`GET https://apizie.tech/v1/business:gladly/tasks-get-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| taskId | string | yes | Id of the task requested |

### Update task
`POST https://apizie.tech/v1/business:gladly/tasks-update-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| taskId | string | yes | Id of the task that is to be updated |
| body | object | no | JSON request body |

### Get task comments
`GET https://apizie.tech/v1/business:gladly/tasks-get-task-comments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| taskId | string | yes | Id of the task comments are requested for. |

### Add task comment
`POST https://apizie.tech/v1/business:gladly/tasks-add-task-comment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| taskId | string | yes | Id of the task that will be commented on. |
| body | object | no | JSON request body |

### Get task comment
`GET https://apizie.tech/v1/business:gladly/tasks-get-comment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| taskId | string | yes | Task id |
| commentId | string | yes | Comment id |

### Get custom attribute
`GET https://apizie.tech/v1/business:gladly/freeform-topics-get-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customAttributeId | string | yes | id of the custom attribute |

### Find customers
`GET https://apizie.tech/v1/business:gladly/customers-find-profiles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| email | string | no | customer email address to search on. |
| externalCustomerId | string | no | Customer ID in your system of record for Customer Profiles linked to a Lookup Adaptor installed prior to 05/12/21. If Customer Profile is… |
| phoneNumber | string | no | Phone number in E.164 format. The value should be URL escaped where `+` becomes `%2B`. |

### Create customer
`POST https://apizie.tech/v1/business:gladly/customers-create-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get customer
`GET https://apizie.tech/v1/business:gladly/customers-get-profile-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | id of the customer |

### Update customer
`POST https://apizie.tech/v1/business:gladly/customers-update-profile-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | id of the customer |
| body | object | yes | JSON request body |

### Create a User Identity JWT
`POST https://apizie.tech/v1/business:gladly/user-identity-generate-jwt` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Search public answers
`GET https://apizie.tech/v1/business:gladly/answers-search-results` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| orgId | string | yes | id of your organization You can look up the ID using the [Get organization](index.html#tag/Organization) API. |
| q | string | no | search term |
| lng | string | no | language code |
| audienceId | string | no | Audience ID. The Audience ID can be retrieved by going to Settings > Audiences in Gladly, then clicking on the Edit button next to the… |

### List public answers
`GET https://apizie.tech/v1/business:gladly/answers-list-public` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| orgId | string | yes | id of your organization You can look up the ID using the [Get organization](index.html#tag/Organization) API. |
| lng | string | yes | Language of the answers returned Defaults to `en-us` |
| audienceId | string | yes | Audience ID for answers returned - optional. The Audience ID can be retrieved by going to Settings > Audiences in Gladly, then clicking on… |

### List Help Center Answer Titles
`GET https://apizie.tech/v1/business:gladly/answers-list-answer-titles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| orgId | string | yes | id of your organization You can look up the ID using the [Get organization](index.html#tag/Organization) API. |
| helpCenterId | string | yes | Help Center ID You can look up the ID by going to Settings > Help Center in Gladly, then clicking on the 3 dots next to the Help Center… |
| lng | string | yes | Language of the answers returned Defaults to `en-us` |
| audienceId | string | yes | Audience ID for answers returned - optional. The Audience ID can be retrieved by going to Settings > Audiences in Gladly, then clicking on… |

### Get public answer
`GET https://apizie.tech/v1/business:gladly/answers-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| orgId | string | yes | id of your organization You can look up the ID using the [Get organization](index.html#tag/Organization) API. |
| answerId | string | yes | id of the answer |
| lng | string | no | language code |

### List Agents
`GET https://apizie.tech/v1/business:gladly/agents-list` (byok)

### Get Agent
`GET https://apizie.tech/v1/business:gladly/agents-get-agent-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| agentId | string | yes | id of the agent |

### Get Agent CallRecorder
`GET https://apizie.tech/v1/business:gladly/agents-get-call-recorder-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| agentId | string | yes | Gladly ID or Gladly email address of the agent |

### Update Agent CallRecorder
`POST https://apizie.tech/v1/business:gladly/agents-update-call-recorder` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| agentId | string | yes | Gladly ID or Gladly email address of the agent |
| body | object | yes | JSON request body |

### Get organization
`GET https://apizie.tech/v1/business:gladly/organization-get-metadata` (byok)

### List inboxes
`GET https://apizie.tech/v1/business:gladly/inboxes-list-metadata` (byok)

### Get inbox
`GET https://apizie.tech/v1/business:gladly/inboxes-get-metadata` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| inboxId | string | yes | id of the inbox |

### List teams
`GET https://apizie.tech/v1/business:gladly/teams-list-teams` (byok)

### Get team
`GET https://apizie.tech/v1/business:gladly/teams-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| teamId | string | yes | id of the team |

### List topics
`GET https://apizie.tech/v1/business:gladly/topics-list` (byok)

### Get topic
`GET https://apizie.tech/v1/business:gladly/topics-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| topicId | string | yes | id of the topic |

### List schedules
`GET https://apizie.tech/v1/business:gladly/export-list-schedules` (byok)

### List jobs
`GET https://apizie.tech/v1/business:gladly/export-jobs-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| status | string | no | export job status to search on. |

### Get job
`GET https://apizie.tech/v1/business:gladly/export-job-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| jobId | string | yes | id of the job |

### Delete job
`POST https://apizie.tech/v1/business:gladly/export-delete-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| jobId | string | yes | id of the job |

### Get file
`GET https://apizie.tech/v1/business:gladly/export-download-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| jobId | string | yes | id of the job |
| filename | string | yes | name of the file |

### Generate a report
`POST https://apizie.tech/v1/business:gladly/reports-generate-report-csv` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### List webhooks
`GET https://apizie.tech/v1/business:gladly/webhooks-list` (byok)

### Create webhook
`POST https://apizie.tech/v1/business:gladly/webhooks-create-webhook` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get webhook
`GET https://apizie.tech/v1/business:gladly/webhooks-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| webhookId | string | yes | id of the webhook |

### Update webhook
`POST https://apizie.tech/v1/business:gladly/webhooks-update-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| webhookId | string | yes | id of the webhook |
| body | object | yes | JSON request body |

### Delete webhook
`POST https://apizie.tech/v1/business:gladly/webhooks-delete-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| webhookId | string | yes | id of the webhook |

### Gladly will perform a POST request to your endpoint when the event occurs. Your service is expected to…
`POST https://apizie.tech/v1/business:gladly/payloads-notify-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Generate a work session report
`POST https://apizie.tech/v1/business:gladly/reports-generate-work-session-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### List events
`GET https://apizie.tech/v1/business:gladly/events-list-stream-of-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| startAt | string | yes | Starting time of the events interval. This is based on the `timestamp` field which indicates when the event was recorded. Must be from… |
| endAt | string | no | Ending time of the events interval. This is based on the `timestamp` field which indicates when the event was recorded. If unspecified,… |
| entities | array | yes | Entity types that have associated events. Any number of types is acceptable and at least one must be present Available Types:… |

## Example
```
curl "https://apizie.tech/v1/business:gladly/communications-send-sms" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Gladly API API?
Create a free Apizie key, then send POST https://apizie.tech/v1/business:gladly/communications-send-sms with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Gladly API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Gladly API itself also needs your own key from organization.gladly.com.

### Can AI agents use the Gladly API API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key business:gladly.

### What is the status of the Gladly API API?
Needs your own provider key (bring your own key)