Schedules

List Schedules

List schedules for the workspace, latest run_at first by default, with optional filters.

The X-Total-Count response header carries the number of schedules matching the filters and search, so clients can page with limit and offset.

get/v1/schedules

Request

  • Base URL: https://api.pinbridge.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.pinbridge.io/v1/schedules
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Query parameters

limitinteger
offsetinteger
qstring nullable

Case-insensitive search across the pin title, description and link URL

sort'run_at_desc' | 'run_at_asc' | 'created_at_desc' | 'created_at_asc' | 'title_asc' | 'title_desc' | 'status_asc' | 'status_desc'

Sort order; run_at_asc lists the next run first

account_idstring uuid nullable

Only schedules for this Pinterest account

board_idstring nullable

Only schedules targeting this board

status'scheduled' | 'queued' | 'deferred' | 'running' | 'done' | 'failed' | 'canceled'

Schedule status enum.

Only schedules in this status

sincestring date-time nullable

Only schedules running at or after this ISO 8601 timestamp

untilstring date-time nullable

Only schedules running before this ISO 8601 timestamp

Headers

x-api-keystring nullable
authorizationstring nullable

Response

Successful Response

idstring uuid required
workspace_idstring uuid required
pinterest_account_idstring uuid required
run_atstring date-time required
status'scheduled' | 'queued' | 'deferred' | 'running' | 'done' | 'failed' | 'canceled' required

Schedule status enum.

payloadobject required
last_errorstring nullable
pin_idstring uuid nullable
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.