Developers API reference Version 1 · generated from the code openapi.json
Routes

favorites

List favorites

GET /api/v1/favorites

Every binder and flow the account keeps, alphabetical, each with its state. A favorite that no longer opens stays listed until it is removed.

Required scope: read

Response

200 array of Favorite

  • id integer

    Id of the favorite.

  • type string

    What it keeps: a binder or a flow.

  • entity_id integer or null

    Id of the binder or the flow; null once it was deleted.

  • name string

    Its name, as last seen while it opened.

  • state string

    available: it opens. closed: still there, taken offline by its author -- it does not open. unavailable: deleted, or no longer shared with you, no longer public, or out of an organisation you left. A favorite is never removed on its own.

  • created_at date-time

    When it was added.

Errors

  • 401

    No valid credential.

  • 403

    The credential lacks the required scope, or the account may not do this.

  • 429

    Too many requests; Retry-After gives the seconds to wait.

planner_banner_ad_pt