These endpoint(s) are available only to Otter Super Admins. Otter APIs provide programmatic access to retrieve channels, conversations, transcripts, audio, action items, insights, outlines, and workspace details from your Otter account. For general information about APIs and Webhooks, check out our articles:
Available endpoints for super admins:
GET /workspace
Use this endpoint to get the workspace for the authenticated user. The response includes workspace details such as the workspace ID, name, owner, member count, handle, and type.
Example Request:
curl -X GET "https://api.otter.ai/v1/workspace" \
-H "Authorization: Bearer YOUR_API_KEY"Response:
Returns a WorkspaceGetResponse containing the authenticated user’s workspace details.
- meta: Response metadata, including retrieved_at
- data: The authenticated user’s workspace object
{
"meta": {
"retrieved_at": "2025-07-31T12:00:00Z"
},
"data": {
"id": 42,
"name": "workspace name",
"owner": {
"id": "user_id",
"name": "Jane Doe",
"first_name": "Jane",
"last_name": "Doe",
"email": "Jane@test.com"
},
"member_count": 50,
"handle": "otter.ai",
"type": "business"
}
}Workspace object:
| Field | Type | Description |
| id | integer | Unique workspace identifier |
| name | string | Name of the workspace |
| owner | User | Owner of the workspace |
| member_count | integer | Number of members in the workspace |
| handle | string | Workspace handle (e.g., domain or identifier like otter.ai) |
| type | string | Type of workspace (e.g., business) |
Error responses:
| Status | Description |
| 404 | User not in a workspace |
GET /workspace/{id}/conversations
Use this endpoint to list all conversations in a workspace. Results are returned in reverse chronological order (most recent first) and use cursor-based pagination for efficient retrieval. Access is restricted to super admins in workspaces where super admin is enabled; otherwise, the request is denied.
Path parameters:
| Parameter | Type | Required | Description |
| id | string | Yes | Workspace ID |
Query parameters:
| Parameter | Type | Required | Description |
| limit | integer | No | Number of items to return per page. Minimum: 1, Maximum: 100. |
| cursor | string | No | Cursor for pagination. Use the next_cursor value returned in the previous response to retrieve the next page of results. |
Example request:
curl -X GET "https://api.otter.ai/v1/workspace/{id}/conversations?limit=20&cursor=" \
-H "Authorization: Bearer YOUR_API_KEY"Response:
Returns a ConversationListResponse containing cursor metadata and a list of conversations in the workspace:
- meta: Pagination metadata, including retrieved_at, has_more, and next_cursor
- data: An array of conversation objects
{
"meta": {
"retrieved_at": "2025-07-31T12:00:00Z",
"has_more": true,
"next_cursor": "next_cursor_position"
},
"data": [
{
"id": "conversation_id",
"title": "product launch meeting",
"url": "https://otter.ai/u/conversation_id",
"owner": {
"id": "user_id",
"name": "Jane Doe",
"first_name": "Jane",
"last_name": "Doe",
"email": "Jane@test.com"
},
"created_at": "2025-07-31T12:00:00Z",
"process_status": {
"abstract_summary": null,
"action_item": null,
"outline": null
},
"calendar_guests": [
{
"name": "John Doe",
"email": "john@test.com"
}
],
"shared_emails": [
{
"email": "hello@example.com",
"user": {
"id": "user_id",
"name": "Jane Doe",
"first_name": "Jane",
"last_name": "Doe",
"email": "Jane@test.com"
},
"permission": "collaborate"
}
],
"shared_channels": [
{
"channel": {
"id": "channel_id",
"name": "backend product meeting",
"member_count": 50,
"owner": {
"id": "user_id",
"name": "Jane Doe",
"first_name": "Jane",
"last_name": "Doe",
"email": "Jane@test.com"
}
},
"permission": "collaborate"
}
],
"abstract_summary": "This meeting discussed the next steps in the project launch",
"conf_join_url": "https://zoom.us/j/1234567890"
}
]
}Error Responses:
| Status | Description |
| 400 | Invalid pagination parameters |
| 404 | Workspace not found |
Feedback
0 comments
Article is closed for comments.