/drafts

get

https://api.dev.orbit.do/v5/drafts

List transport drafts filtered by section (inbox, quotes, drafts, archive, recurring). Pass section=recurring to list recurring-master drafts; combine with recurringFilter to narrow by lifecycle status (active/paused/ended).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

section

string

enum

required

The navigation section to list drafts for. Each section represents a different stage in the draft lifecycle. recurring lists recurring-master drafts (active, paused, or ended).

Allowed:

inboxFilter

string

enum

Sub-filter for inbox section.

Allowed:

quotesFilter

string

enum

Sub-filter for quotes section.

Allowed:

archiveFilter

string

enum

Sub-filter for archive section.

Allowed:

recurringFilter

string

enum

Sub-filter for the recurring section. active returns drafts with status active-recurring; paused returns paused-recurring; ended returns ended-recurring. Omit to return all recurring masters across lifecycle statuses.

Allowed:

cursor

string

Cursor to retrieve next page.

limit

string

Maximum count of items in one page.

sorted

string

enum

Sorting direction by creation date.

Allowed:

Responses

400

bad request

401

unauthorized

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Page of transport drafts