Relay

List relays addressed to a role's inbox

get/api/relay/inbox

Request

  • Base URL: http://localhost:38200
  • URL: http://localhost:38200/api/relay/inbox
  • Auth: one of:
    • HTTP bearer
    • API key in cookie token

Query parameters

rolestring required
project_idinteger
include_all'true' | '1' | 'false' | '0'

Include claimed/advanced relays, not just open ones.

Response

Inbox.

Example response

{
  "relays": [
    {
      "kind": "work_item",
      "status": "not_started"
    }
  ]
}

Changes

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