Contact fields

GET

/v1/contact-fields

const url = 'https://api.threadkite.app/v1/contact-fields?resource=contact&includeArchived=true';
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/contact-fields?resource=contact&includeArchived=true' \
  --header 'Authorization: Bearer <token>'

Facts kept about contacts beyond name, email and phone: your industry pack’s fields first (read-only), then your own. Values are on each contact’s attributes, by key. Archived fields are left out unless includeArchived=true.

Authorizations

api_key
contacts:read

Parameters

Query Parameters

resource

Contact fields (the default) or company fields

string

default: contact

Allowed values: contact company

Contact fields (the default) or company fields

includeArchived

Include archived fields

string

default: false

Allowed values: true false

Include archived fields

Responses

200

application/json

Array<object>

object

required

Null for your industry pack’s fields, which every business like yours has

string format: uuid

nullable

key

required

The key values are stored under in a contact’s attributes; never changes

string

label

required

string

resource

required

contact (the default: values on contacts) or company (values on companies)

string

Allowed values: contact company

type

required

Values are text, numbers, dates (YYYY-MM-DD), true or false, or one of choices

string

Allowed values: text number date boolean choice

choices

required

The options of a choice field

Array<string>

origin

required

organisation (yours), pack (your industry pack) or integration

string

Allowed values: organisation pack integration

archived

required

Archived: values are kept but can no longer be set

boolean

readOnly

required

Pack fields cannot be changed or archived

boolean

createdAt

required

string format: date-time

nullable

Example

[
  {
    "key": "finance_end_date",
    "label": "Finance end date",
    "resource": "contact",
    "type": "text",
    "origin": "organisation"
  }
]

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
}