How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Gladly Agents API

An **Agent** represents the user profile of a person who helps customers in Gladly.The API allows you to lookup Agents who participated in conversations with customers.

Gladly Agents API is one of 28 APIs that Gladly publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 10 JSON Schema definitions.

Tagged areas include Agents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, a JSON-LD context, and 10 JSON Schemas.

This API exposes 4 operations across 3 paths, and defines 2 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against 2 base URLs: https://{organization}.gladly.com/api/v1, https://{organization}.gladly.qa/api/v1.

4 operations 3 paths 2 schemas 3 GET1 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://organization.gladly.com/api/v1
Authentication
HTTP Basic, HTTP Basic
Resource Areas
1

Authentication & Security 2

Gladly Agents API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuth). It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • BasicAuth — Gladly API uses token-based Basic Authentication. API tokens are associated with designated Gladly users. To create and use an API token, your user must have t…
  • basicAuth — HTTP Basic auth — username is the API user email; password is the API token. Requires the "API User" permission.

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 3 GET, 1 PATCH. Each is listed below with its method, path, parameters, and response codes.

Agents 4

An Agent represents the user profile of a person who helps customers in Gladly. The API allows you to lookup Agents who participated in conversations with customers.

GET
/api/v1/agents
List Agents
getAgents → 200
GET
/api/v1/agents/{agentId}
Get Agent
getAgent 1 param → 200
GET
/api/v1/agents/{agentId}/call-recorder
Get Agent CallRecorder
getAgentCallRecording 1 param → 200404
PATCH
/api/v1/agents/{agentId}/call-recorder
Update Agent CallRecorder
updateAgentCallRecording 1 param body → 204404

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Error (3 properties), Errors (1 property). Each schema is shown below with its type and property counts.

Errors
object
1 property
Error
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gladly-agents-api-openapi.yml Raw ↑

Other APIs Gladly publishes across the network.

Gladly Lookup API
Gladly Chat SDK
Gladly Sidekick iOS SDK
Gladly Sidekick Android SDK
Gladly Help Center
Gladly App Platform
Gladly Webhooks
Gladly Answer Management API
Gladly Audiences API
Gladly Business Hours API
Gladly Communications API
Gladly Conversations API
Where this information came from

This is an independent, third-party profile of Gladly Agents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.