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

Nextiva Conversations API

Operations related to conversations

Nextiva Conversations API is one of 10 APIs that Nextiva publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Conversations. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 10 operations across 10 paths, and defines 22 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.nextiva.com.

10 operations 10 paths 22 schemas 10 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.nextiva.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Nextiva Conversations API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer token authentication (JWT).

Paths & Operations 10

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

Conversations 10

Operations related to conversations

GET
/data/api/types/conversation
Fetch all conversations
fetchConversations 2 params → 200default
GET
/analytics/api/conversations/{conversationId}/workitems
Fetch a conversation by ID, including its associated workitems
fetchConversationById 13 params → 200default
GET
/analytics/api/conversations/{conversationId}/workitems/{workItemStatus}
Fetch workitems within a conversation by their status
fetchConversationWorkItemsByStatus 4 params → 200default
GET
/analytics/api/campaigns/{campaignId}/recentconversationworkitems
Fetch recent conversation workitems for a campaign
fetchConversationByCampaignId 18 params → 200default
GET
/analytics/api/recentConversationWorkitems
Fetch recent conversation workitem engagements
fetchRecentConversationWorkitemEngagements 5 params → 200default
GET
/analytics/api/conversations/workitems
Fetch conversation history by participant ID
fetchConversationHistoryByParticipantId 3 params → 200default
GET
/analytics/api/tickets/{ticketId}/conversations
Fetch conversations associated with a ticket
fetchTicketConversations 1 param → 200default
GET
/data/api/types/conversation/unread/counts
Fetch unread conversation counts
fetchUnreadCounts → 200default
GET
/analytics/api/types/conversation/{conversationId}/workitems/{workitemId}/transcriptions-and-recordings
Fetch transcriptions and recordings for a specific workitem within a conversation
fetchTranscriptionsAndRecordings 3 params → 200default
GET
/analytics/api/conversationActivitySummary
Fetch a summary of conversation activity (DEPRECATED)
fetchConversationActivitySummary → 200default

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are Conversation (23 properties), Participant (14 properties), UserParticipantDetails (7 properties), UnreadCounts (5 properties). Each schema is shown below with its type and property counts.

ConversationByIdResponse
Message
object
1 property
ContactArray
object
1 property
TranscriptionsAndRecordingsResponse
ContactPartial
object
2 properties
ConversationCallRecordingData
object
2 properties
Participant
object
14 properties
RecentConversationWorkitemEngagementsResponse
PaginatedResponse
object
3 properties
Conversation
object
23 properties
EngagementData
object
1 property
UnreadCounts
object
5 properties
TicketConversationsResponse
ConversationActivitySummaryResponse
array
Contact
object
1 property
ConversationActivitySummary
object
3 properties
ConversationFilterTabType
string
UserParticipantDetails
object
7 properties
ConversationsResponseWithContactArray
ConversationsResponse
Workitem
object
1 property
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nextiva-conversations-api-openapi.yml Raw ↑

Other APIs Nextiva publishes across the network.

Nextiva Authentication API
Nextiva Call Management API
Nextiva Campaigns API
Nextiva DTMF API
Nextiva Email API
Nextiva SMS Messaging API
Nextiva Tickets API
Nextiva Transfers API
Nextiva Workitems API
Where this information came from

This is an independent, third-party profile of Nextiva Conversations 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.