Skip to content
Speccy

The suggestions for a profile, as threads on its checks (REQ-015).

GET
/profiles/{key}/threads
curl --request GET \
  --url https://example.com/api/v1/profiles/example/threads

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
key
required
string

Responses

Section titled “ Responses ”

200

Section titled “200”

The threads.

Media typeapplication/json
object
items
required
Array<object>
object
id
required
string format: uuid
doc_id
string format: uuid
profile_key
string
anchor_kind
required
string
Allowed values: text section finding check
anchor
required

For text, an Anchor. For a section, {heading_path}. For a finding, {finding_id, check_slug}. For a check, {check_slug}.

object
key
additional properties
any
addressed_to
required
string
Allowed values: humans ai
title
required
string
handoff_id

The handoff a builder opened this thread from (REQ-137).

string format: uuid
handoff_version

The bundle version the builder took. 0 when no handoff opened it.

integer format: int64
blocking
required
boolean
status
required
string
Allowed values: open resolved
created_by
required
string
created_at
required
string format: date-time
last_message_at
required
string format: date-time
message_count
required
integer
Example
{
  "items": [
    {
      "anchor_kind": "text",
      "addressed_to": "humans",
      "status": "open"
    }
  ]
}

default

Section titled “default”

An error.

Media typeapplication/problem+json

RFC 9457 problem details with a stable code.

object
type
required
string
title
required
string
status
required
integer
detail
string
instance
string
code
required

A stable machine-readable error code.

string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example"
}