People in the team, for owner pickers and @mentions

GET

/v1/team/people

const url = 'https://api.threadkite.app/v1/team/people';
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/team/people \
  --header 'Authorization: Bearer <token>'

Active members A to Z. Only people on a Full seat can own threads; everyone can be mentioned in a note. Pass a thread’s inboxId to list only people who can see it.

Authorizations

api_key
threads:read

Parameters

Query Parameters

inboxId

Only people who can see this inbox (its members, owners and admins): for a thread’s owner picker and @mentions

string format: uuid

Only people who can see this inbox (its members, owners and admins): for a thread’s owner picker and @mentions

Responses

200

application/json

Array<object>

object

userId

required

string

name

required

string

seatType

required

string

Allowed values: full basic

canOwn

required

Can own threads (Full seats); Basic seats can still be @mentioned

boolean

locationIds

required

Where they work (information only); empty means group-wide

Array<string>

inboxIds

required

The inboxes they are in (of those you can see)

Array<string>

seesEveryInbox

required

An owner or admin: sees every inbox without being a member

boolean

Example

[
  {
    "userId": "usr_8f2c",
    "name": "James Patel",
    "seatType": "full"
  }
]

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
}