Everyone in the organisation

GET

/v1/team/members

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

• Threadkite API

Their roles, seats, inboxes and work locations. Match someone in your system by email. For an API key or an app, isYou is always false.

Authorizations

• api_key
  members:read

Responses

200

Media typeapplication/json

Array<object>

object

id

required

Membership id

string format: uuid

userId

required

string

name

required

string

email

required

string format: email

image

required

Their picture; null to show their initials

string

nullable

role

required

string

Allowed values: owner admin manager staff

seatType

required

string

Allowed values: full basic

locationIds

required

Where they work (information only: defaults, signatures, filters); empty means group-wide

Array<string>

inboxIds

required

The inboxes they are in. Only these threads are theirs to see, unless they are an owner or admin

Array<string>

jobTitle

required

Fills {{user.jobTitle}} in signatures

string

nullable

directPhone

required

Fills {{user.phone}} in signatures

string

nullable

mobilePhone

required

Fills {{user.mobile}} in signatures

string

nullable

lastActiveAt

required

string format: date-time

nullable

isYou

required

This is you

boolean

status

required

inactive: paused while the organisation is on the Free plan, back on upgrade

string

Allowed values: active inactive

Example

[
  {
    "name": "Priya Shah",
    "role": "owner",
    "seatType": "full",
    "jobTitle": "Sales Executive",
    "directPhone": "0113 496 0123",
    "mobilePhone": "07700 900123",
    "status": "active"
  }
]

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"
    }
  ]
}

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
}