HAhappyscribe
Conversations

List all conversations

Returns the conversations you've previously created, most recent first. The response contains metadata about each conversation, not the transcript content — use Exports to retrieve content.

For workspaces enrolled in the Memory API, the person_id, person_email, company_id, and company_domain filters are available, and each result embeds people and companies arrays.

get/conversations

Request

  • Base URL
    https://www.happyscribe.com/api/v1
  • Auth
    API key in header Authorization

Query parameters

workspace_idstring required
Example:wks_01k6a2r9s8x7c2dvq3m5n6p4ab

Workspace to get the conversations from. A wks_ id; integer workspace ids are still accepted.

folder_idinteger

Filter to conversations inside the specified folder or its subfolders.

tagsstring[]

List of tags to filter by.

person_idinteger

(Memory API) Filter to conversations linked to this person.

person_emailstring

(Memory API) Same as person_id, resolved by email address.

company_idinteger

(Memory API) Filter to conversations linked to people from this company.

company_domainstring

(Memory API) Same as company_id, resolved by domain.

pageinteger

Page number to retrieve.

per_pageinteger

Number of results per page. Maximum 100.

Response

A paginated list of conversations.

Example response

{
  "results": [
    {
      "id": "e458099e7f8da14f9625854ba7b6a026917ad306",
      "name": "interview1.mov",
      "folder": {
        "id": 521,
        "name": "Marketing interviews"
      },
      "created_at": "2024-10-29T14:31:29.799Z",
      "updated_at": "2024-10-29T14:31:38.495Z",
      "state": "automatic_done",
      "sharing_enabled": false,
      "language": "en-GB",
      "audio_length_in_seconds": 42,
      "cost_in_cents": 100,
      "refunded": false,
      "tags": [
        "To do",
        "req_1234"
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.