Skip to content
ThreadkiteThreadkite Docs

The active organisation (for an API key, its organisation)

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

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
id
required
string format: uuid
name
required
string
slug
required
string
country
required

ISO 3166-1 alpha-2

string
timeZone
required
string
currency
required

ISO 4217

string
locale
required
string
region
required
string
Allowed values: uk eu us
industryPack
required

The industry pack the organisation uses, or null for none

string
nullable
Allowed values: automotive
mainLocationId
required

The location whose opening hours apply where an inbox and a thread have no location (group-wide inboxes); null for none

string format: uuid
nullable
plan
required
string
status
required
string
Allowed values: trialing active past_due suspended cancelled
trialEndsAt
required

End of the free trial

string format: date-time
nullable
signInDomain
required

The business email domain the organisation uses, e.g. smithmotors.co.uk

string
nullable
restrictToSignInDomain
required

Only people with an address at signInDomain can join

boolean
inboundAddress
required

The organisation’s own address: email sent or forwarded here arrives in the default inbox

string
nullable
logo
required
One of:
object
url
required
string
width
required
integer
>= -9007199254740991 <= 9007199254740991
height
required
integer
>= -9007199254740991 <= 9007199254740991
squareLogo
required
One of:
object
url
required
string
source
required

upload (uploaded or cropped by your team) or website (your website’s icon)

string
Allowed values: upload website
currencyLockedReason
required

Why the currency can’t be changed (a live subscription is priced in it), in plain English; null when it can

string
nullable
createdAt
required
string format: date-time

Example 

{
  "name": "Smith Motors",
  "slug": "smith-motors",
  "country": "GB",
  "timeZone": "Europe/London",
  "currency": "GBP",
  "locale": "en-GB",
  "region": "uk",
  "industryPack": "automotive",
  "plan": "pro",
  "status": "trialing",
  "inboundAddress": "smith-motors@in.threadkite.net",
  "logo": {
    "url": "https://api.threadkite.com/business-images/3f2a….png"
  },
  "squareLogo": {
    "url": "https://api.threadkite.com/avatars/5b1d….png",
    "source": "upload"
  },
  "currencyLockedReason": "Your plan is billed in GBP. Contact us to change it."
}

401

Section titled “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

Section titled “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

Section titled “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

Section titled “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
}