One action run

GET

/v1/action-runs/{id}

curl --request GET \
  --url https://api.threadkite.app/v1/action-runs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

• Threadkite API

Authorizations

• api_key
  threads:read

Parameters

Path Parameters

id

required

string format: uuid

Responses

200

Media typeapplication/json

object

id

required

string format: uuid

threadId

required

string format: uuid

nullable

contactId

required

string format: uuid

nullable

action

required

object

key

required

string

label

required

string

source

required

object

kind

required

string

Allowed values: connection app

id

required

The connection’s id, or the app installation’s

string format: uuid

name

required

string

capability

required

string

nullable

card

required

object

title

required

string

subtitle

required

string

nullable

tone

required

string

Allowed values: neutral success warning danger

lines

required

Array<object>

object

label

required

string

value

required

string

body

required

string

nullable

smallPrint

required

Array<string>

customerMessage

required

What to send the customer, when the action gives something

object

text

required

string

subject

required

string

nullable

editable

required

boolean

url

required

Where it opens in the other system

string

nullable

sentMessageId

required

Once sent to the customer

string format: uuid

nullable

createdBy

required

One of:

object

object

id

required

string

name

required

string

createdAt

required

string format: date-time

Example

{
  "source": {
    "kind": "connection",
    "name": "Northern DMS"
  },
  "card": {
    "tone": "neutral"
  },
  "createdBy": {
    "id": "usr_8f2c",
    "name": "James Patel"
  }
}

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

404

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
}