The values an item filter can take

GET

/v1/threads/item-filter-values

curl --request GET \
  --url 'https://api.threadkite.app/v1/threads/item-filter-values?key=colour' \
  --header 'Authorization: Bearer <token>'

• Threadkite API

For a values item filter (GET /v1/inboxes/list-fields): the values the items of the threads you can see have (in one inbox with inboxId), with how many threads have each, most first, up to 50. Pass them to GET /v1/threads?item=.

Authorizations

• api_key
  threads:read

Parameters

Query Parameters

key

required

A values item filter (GET /v1/inboxes/list-fields)

string

/^[A-Za-z][A-Za-z0-9_]{0,63}$/

Example

colour

A values item filter (GET /v1/inboxes/list-fields)

inboxId

Only this inbox’s threads (every inbox you can see when left out)

string format: uuid

Only this inbox’s threads (every inbox you can see when left out)

Responses

200

Media typeapplication/json

object

data

required

The values, most threads first (up to 50), counted over every folder but Spam; values longer than 100 characters are left out

Array<object>

object

value

required

string

label

required

As people read it: a choice’s label, otherwise the value

string

count

required

Threads with an item of it

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "data": [
    {
      "value": "Red",
      "label": "Red",
      "count": 14
    }
  ]
}

400

Media typeapplication/json

object

statusCode

required

number

code

required

Stable machine-readable reason

string

message

required

string

errors

With code invalid: every problem with the request, by field (message is the first)

Array<object>

object

path

required

Dotted path inside the item, e.g. attributes.price.amountMinor

string

message

required

string

Example

{
  "statusCode": 403,
  "code": "forbidden",
  "message": "You do not have permission to do that.",
  "errors": [
    {
      "message": "Enter the make"
    }
  ]
}

401

Missing or invalid API key

Media typeapplication/json

object

statusCode

required

number

code

required

Stable machine-readable reason

string

message

required

string

errors

With code invalid: every problem with the request, by field (message is the first)

Array<object>

object

path

required

Dotted path inside the item, e.g. attributes.price.amountMinor

string

message

required

string

Example

{
  "statusCode": 403,
  "code": "forbidden",
  "message": "You do not have permission to do that.",
  "errors": [
    {
      "message": "Enter the make"
    }
  ]
}

402

The organisation is on the Free plan (code upgrade_required)

Media typeapplication/json

object

statusCode

required

number

code

required

Stable machine-readable reason

string

message

required

string

feature

required

The feature that needs Pro

string

nullable

Allowed values: extraSeats connections aiAssistant aiReplies rules fullReports api inboxes bulkMessages videoMessages

upgradePath

required

Where to upgrade or pay, in the web app

string

Example

{
  "statusCode": 402,
  "code": "upgrade_required",
  "message": "Connections are part of Pro. Upgrade to connect texts, calls and more.",
  "feature": "extraSeats",
  "upgradePath": "/settings/billing"
}

403

The key does not have the scope (or the person the permission)

Media typeapplication/json

object

statusCode

required

number

code

required

Stable machine-readable reason

string

message

required

string

errors

With code invalid: every problem with the request, by field (message is the first)

Array<object>

object

path

required

Dotted path inside the item, e.g. attributes.price.amountMinor

string

message

required

string

Example

{
  "statusCode": 403,
  "code": "forbidden",
  "message": "You do not have permission to do that.",
  "errors": [
    {
      "message": "Enter the make"
    }
  ]
}

404

Media typeapplication/json

object

statusCode

required

number

code

required

Stable machine-readable reason

string

message

required

string

errors

With code invalid: every problem with the request, by field (message is the first)

Array<object>

object

path

required

Dotted path inside the item, e.g. attributes.price.amountMinor

string

message

required

string

Example

{
  "statusCode": 403,
  "code": "forbidden",
  "message": "You do not have permission to do that.",
  "errors": [
    {
      "message": "Enter the make"
    }
  ]
}

429

Rate limit reached

Media typeapplication/json

object

statusCode

required

number

code

required

Stable machine-readable reason

string

message

required

string

retryAfter

required

Seconds until another request will be accepted

number

Example

{
  "statusCode": 429,
  "code": "rate_limited",
  "message": "Too many requests. Each key can make 120 requests a minute; try again in 12 seconds.",
  "retryAfter": 12
}