Skip to content
Kindgi

List a flow's pinned versions

View as Markdown
GET
/v1/flows/{flowId}/pinned-versions
curl --request GET \
  --url https://example.com/v1/flows/example/pinned-versions \
  --header 'Authorization: Bearer <token>'

Every scope with a version pinned, and the change that set it.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
flowId
required
string

FlowId — dotted namespace (acme.ingest-invoice).

Responses

Section titled “Responses”

200

Section titled “200”

The pins.

Media typeapplication/json
object
data
required
Array<object>
object
itemId
required
string
scope
required
One of: discriminator: kind

The whole tenant.

object
kind
required
string
Allowed values: tenant
version
required
string
changeId
required

The change that set it.

string format: uuid
setAt
required
string format: date-time
setBy
required

Who pinned or unpinned: a user, or a service token.

object
kind
required
string
Allowed values: user service
id
required
string
Example
{
  "data": [
    {
      "scope": {
        "kind": "tenant"
      },
      "setBy": {
        "kind": "user"
      }
    }
  ]
}

401

Section titled “401”

Missing / malformed / expired / revoked bearer token.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

503

Section titled “503”

The database was too busy to answer in time (database-busy); Retry-After (whole seconds) says when to try again.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

See also