Skip to main content
GET
/
v1
/
schedule
/
{id}
Get Schedule
curl --request GET \
  --url https://api.heymarket.com/v1/schedule/{id} \
  --header 'Authorization: Bearer <token>'
{
  "created": "<string>",
  "execute": "<string>",
  "id": 123,
  "inbox_id": 123,
  "local_id": "<string>",
  "meta": {
    "campaign_id": 123,
    "campaign_step_id": 123,
    "campaign_target_phone": "<string>",
    "content": {
      "attachments": [
        {
          "name": "<string>",
          "type": "<string>",
          "url": "<string>"
        }
      ],
      "gallery": [
        {
          "annotation_position": "<string>",
          "annotation_text": "<string>",
          "original_url": "<string>",
          "url": "<string>"
        }
      ],
      "local_day": 123,
      "local_time": "<string>",
      "offset": 123,
      "template": 123,
      "text": "<string>",
      "to": "<string>"
    },
    "conversation_id": 123,
    "list_id": 123
  },
  "op": "<string>",
  "rev": 123,
  "updated": "<string>"
}
Use this endpoint to inspect a scheduled message before delivery.

Authorizations

Authorization
string
header
required

Recommended authentication for new integrations. Generate a short-lived JWT from your API Secret ID and API Secret Key, then pass the signed JWT as a bearer token in the Authorization header.

API Secret credentials are available in the Heymarket app under Settings > Integrations > API. The Secret Key is shown only when it is generated, so copy and store it securely before closing the dialog.

Use the following JWT values:

{
"alg": "HS256",
"typ": "JWT"
}
{
"iss": "YOUR_API_SECRET_ID",
"iat": CURRENT_UNIX_TIMESTAMP
}

Replace CURRENT_UNIX_TIMESTAMP with the current Unix timestamp in seconds when generating the token.

Sign the JWT with HMAC-SHA256 using this signing secret:

YOUR_API_SECRET_ID||YOUR_API_SECRET_KEY

Send the signed JWT as a bearer token:

Authorization: Bearer YOUR_SIGNED_JWT

Tokens expire 5 minutes after the iat timestamp. Generate a new JWT per request, or cache it briefly for less than 5 minutes. Generate JWTs only from trusted server-side code; do not expose the API Secret Key in browser, mobile, or other client-side code.

Path Parameters

id
integer
required

Schedule ID

Response

OK

created
string
execute
string
id
integer
inbox_id
integer
local_id
string
meta
object
op
string
rev
integer
updated
string