What an inbox's list layout can hold

GET

/v1/inboxes/list-fields

const url = 'https://api.threadkite.app/v1/inboxes/list-fields';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.threadkite.app/v1/inboxes/list-fields \
  --header 'Authorization: Bearer <token>'

The thread details, item fields and item filters an inbox’s listLayout can name in your organisation, with labels in your industry’s words. Item filters are what GET /v1/threads?item= takes.

Authorizations

api_key
threads:read

Responses

200

application/json

object

details

required

Array<object>

object

key

required

string

Allowed values: stage score next_appointment source waiting tags owner location

label

required

string

itemFields

required

Array<object>

object

key

required

string

label

required

string

itemFilters

required

Array<object>

object

key

required

string

label

required

string

kind

required

values: some of the values the items have (GET /v1/threads/item-filter-values); range: a lowest and highest number

string

Allowed values: values range

options

required

A choice attribute’s values with their labels, to show a chosen value by its label; null for other filters

Array<object>

nullable

object

value

required

string

label

required

string

Example

{
  "details": [
    {
      "key": "stage",
      "label": "Stage"
    }
  ],
  "itemFields": [
    {
      "key": "attributes.colour",
      "label": "Colour"
    }
  ],
  "itemFilters": [
    {
      "key": "colour",
      "label": "Colour",
      "kind": "values"
    }
  ]
}

401

Missing or invalid API key

application/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)

application/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)

application/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

application/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
}