The organisation's locations

GET

/v1/locations

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

• Threadkite API

Authorizations

• api_key
  locations:read

Responses

200

Media typeapplication/json

Array<object>

object

id

required

string format: uuid

name

required

string

address

required

One of:

object

object

line1

required

string

line2

string

city

required

string

region

string

postcode

required

string

country

required

ISO 3166-1 alpha-2

string

timeZone

required

string

phone

required

E.164

string

nullable

website

required

string

nullable

openingHours

required

Used for response times and the out-of-hours reply

object

monday

Array<object>

object

opens

required

Local time, HH:MM (24-hour)

string

closes

required

Local time, HH:MM; 24:00 for midnight, or earlier than opens to run past it

string

tuesday

Array<object>

object

opens

required

Local time, HH:MM (24-hour)

string

closes

required

Local time, HH:MM; 24:00 for midnight, or earlier than opens to run past it

string

wednesday

Array<object>

object

opens

required

Local time, HH:MM (24-hour)

string

closes

required

Local time, HH:MM; 24:00 for midnight, or earlier than opens to run past it

string

thursday

Array<object>

object

opens

required

Local time, HH:MM (24-hour)

string

closes

required

Local time, HH:MM; 24:00 for midnight, or earlier than opens to run past it

string

friday

Array<object>

object

opens

required

Local time, HH:MM (24-hour)

string

closes

required

Local time, HH:MM; 24:00 for midnight, or earlier than opens to run past it

string

saturday

Array<object>

object

opens

required

Local time, HH:MM (24-hour)

string

closes

required

Local time, HH:MM; 24:00 for midnight, or earlier than opens to run past it

string

sunday

Array<object>

object

opens

required

Local time, HH:MM (24-hour)

string

closes

required

Local time, HH:MM; 24:00 for midnight, or earlier than opens to run past it

string

specialDays

required

Array<object>

object

date

required

Local date, YYYY-MM-DD

string

label

string

periods

required

Empty: closed all day

Array<object>

object

opens

required

Local time, HH:MM (24-hour)

string

closes

required

Local time, HH:MM; 24:00 for midnight, or earlier than opens to run past it

string

createdAt

required

string format: date-time

Example

[
  {
    "name": "Smith Motors Leeds",
    "address": {
      "line1": "1 Kirkstall Road",
      "city": "Leeds",
      "region": "West Yorkshire",
      "postcode": "LS3 1AA",
      "country": "GB"
    },
    "timeZone": "Europe/London",
    "phone": "+441130000000",
    "website": "https://smithmotors.co.uk",
    "openingHours": {
      "monday": [
        {
          "opens": "09:00",
          "closes": "18:00"
        }
      ],
      "tuesday": [
        {
          "opens": "09:00",
          "closes": "18:00"
        }
      ],
      "wednesday": [
        {
          "opens": "09:00",
          "closes": "18:00"
        }
      ],
      "thursday": [
        {
          "opens": "09:00",
          "closes": "18:00"
        }
      ],
      "friday": [
        {
          "opens": "09:00",
          "closes": "18:00"
        }
      ],
      "saturday": [
        {
          "opens": "09:00",
          "closes": "18:00"
        }
      ],
      "sunday": [
        {
          "opens": "09:00",
          "closes": "18:00"
        }
      ]
    },
    "specialDays": [
      {
        "date": "2026-12-28",
        "label": "Bank holiday",
        "periods": [
          {
            "opens": "09:00",
            "closes": "18:00"
          }
        ]
      }
    ]
  }
]

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
}