Appearance

Pins ​

Per-user pins over agents, chats, and workflows. Pins are private to the calling user and surface pinned items first in the matching list endpoints.

List the caller's pins​

GET
/v1/pins

Returns the caller's own pins in pin order (oldest first). Pins are per user; another member of the same organization sees their own. Each item carries its display title, so a pinned list renders without a lookup per pin.

Authorizations​

HTTPBearer
Type
HTTP (bearer)

Parameters​

Query Parameters

resource_type

When set, only pins of this resource type.

Responses​

Successful Response

application/json
JSON
{
  
"items": [
  
  
{
  
  
  
"created_at": "string",
  
  
  
"resource_id": "string",
  
  
  
"resource_type": "string",
  
  
  
"title": "string"
  
  
}
  
]
}

Samples​

Pin an item​

POST
/v1/pins

Pins an agent, chat, or workflow for the calling user. Idempotent: pinning an already pinned item returns the existing pin.

Authorizations​

HTTPBearer
Type
HTTP (bearer)

Request Body​

application/json
Format"uuid"
Valid values"agent""chat""workflow"

Responses​

Successful Response

application/json
JSON
{
  
"created_at": "string",
  
"resource_id": "string",
  
"resource_type": "string"
}

Samples​

Unpin an item​

DELETE
/v1/pins/{resource_type}/{resource_id}

Removes the caller's pin. Idempotent: unpinning something unpinned succeeds.

Authorizations​

HTTPBearer
Type
HTTP (bearer)

Parameters​

Path Parameters

resource_type*
Type
string
Required
Valid values
"agent""chat""workflow"
resource_id*
Type
string
Required
Format
"uuid"

Responses​

Successful Response

Samples​