Skip to main content
GET
Get scheduling job

Authorizations

api_key
string
header
required

Personal API key.

Path Parameters

job_id
string
required

ID of the scheduling job, as returned by Start scheduling posts.

app_id
string
required

ID of the app whose social calendar you want.

Response

The job's progress, and its result once it completes.

job_id
string
required

ID of the scheduling job. Pass it as job_id to Get scheduling job.

Example:

"68a1c4f0d21b4e0a3c77e912"

status
string
required

State of the job: pending before it starts, running while it hands posts over, then completed or failed. A range holding nothing to schedule comes back completed straight away.

Example:

"pending"

phase
string
required

How far the job has got, for display only: pending, prepare, sandbox_sync, finalize, then completed. Read status to decide when the job is done, because these phases change as the pipeline does.

Example:

"finalize"

result
SchedulingJobResult · object | null

What happened to the posts the job took on. Set once status is completed, and null before that or on a failed job.

error
string | null

Set when status is failed, and null otherwise. It is always the same fixed message and carries no detail about the failure, so treat it as a flag rather than something to parse or show as a reason.

Example:

"Scheduling failed. Please try again."