List

Description

List workbench conversations.

Request

HTTP Method: GET

Parameter Description Required Type
search Optional Search term to filter conversations by title No String
favorited Optional Filter by favorited status (true/false) No Boolean
creator_id Optional Filter conversations by the ID of the creator (user) No String
per_page Optional Set the number of results returned per page No Integer
page Optional Specify the page of results to return if there are multiple pages. Defaults to page 1. No Integer 
curl -X GET \
  "https://<<META.tenant.domain>>/api/v1/workbench?per_page=20&page=1&search=weather&favorited=true" \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>'

Response

A successful request will return a JSON object containing a paginated list of workbench conversations.

Field description

Parameter Description
conversations Array of Workbench conversation objects
guid The conversation GUID
title The conversation title
source The source of the conversation
favorited Whether the conversation is favorited by the user
creator_id The ID of the user who created the conversation
created_at ISO 8601 timestamp when the conversation was created
updated_at ISO 8601 timestamp when the conversation was last updated

Sample response

{
  "conversations": [
    {
      "guid": "ca68403e-5594-42a4-bec7-879b0b417a83",
      "title": "Reset user password",
      "source": "tines",
      "favorited": true,
      "creator_id": "12345",
      "created_at": "2025-06-20T08:25:30Z",
      "updated_at": "2025-06-20T08:30:15Z"
    },
    {
      "guid": "b8f2c1a3-9876-4321-a1b2-c3d4e5f6789a",
      "title": "Data analysis discussion",
      "source": "slack",
      "favorited": false,
      "creator_id": "12345",
      "created_at": "2025-06-19T14:20:10Z",
      "updated_at": "2025-06-19T16:45:22Z"
    }
  ],
  "meta": {
    "current_page": "https://<<META.tenant.domain>>/api/v1/workbench?per_page=20&page=1",
    "previous_page": null,
    "next_page": "https://<<META.tenant.domain>>/api/v1/workbench?per_page=20&page=2",
    "next_page_number": 2,
    "per_page": 20,
    "pages": 3,
    "count": 42
  }
}

Pagination

This endpoint supports page-based pagination using the per_page and page parameters:

  • Use per_page to specify the number of results per page
  • Use page to specify which page of results to return (defaults to 1)
  • The response includes a meta object with pagination information including total count and page links

Filtering

  • search: Filters conversations containing the search term in their title
  • favorited: Set to true to only return favorited conversations, false for non-favorited, or omit for all
  • creator_id: Only return conversations created by the specified user ID
Was this helpful?