Retrieve eflow content

The questions and branches, in the same shape PUT /v1/eflows/{id}/content accepts, so a caller can read, edit, and write back without reshaping anything. References between the two are by key, never by id: a key survives the round trip and an id is ours to change.

Requires the eflows:read scope.

Example request

curl https://api.acquainto.com/v1/eflows/eflow_abc123/content \
  -H "Authorization: Bearer acq_live_xxxxxxxx"

Parameters

idpathstringrequired
A eflow id, prefixed `eflow_`.

Responses

200Retrieve eflow content

questionsarray of objectrequired
- idstringrequired
  A question id, prefixed `q_`.
- keystring | nullrequired
  The stable identifier to key your own storage on. Null only for questions authored before keys existed and never re-saved since.
- textstringrequired
  The authored prompt. A label, not a key -- it changes when someone fixes a typo.
- typestringrequired
- requiredbooleanrequired
- optionsarray of object
  Present on select-type questions only.
  - idstringrequired
  - labelstringrequired
  - valuestringrequired
- configobjectrequired
  Whatever type-specific options the question carries beyond `type` and `options`. Two are required, not defaulted: `min` and `max` on a `scale` question (e.g. 1 and 10), and `currency` on a `money` question. A `scale` range spans at most 10 (11 buttons); the widget draws one button per integer and the row cannot wrap.
branchesarray of objectrequired
- idstringrequired
  A branch id, prefixed `br_`.
- keystring | nullrequired
- sourceQuestionKeystring | nullrequired
  The question whose answer opens this branch.
- triggerOptionIdstringrequired
  The option on `sourceQuestionKey` that opens it.
- labelstringrequired
- questionsarray of objectrequired
  - idstringrequired
    A question id, prefixed `q_`.
  - keystring | nullrequired
    The stable identifier to key your own storage on. Null only for questions authored before keys existed and never re-saved since.
  - textstringrequired
    The authored prompt. A label, not a key -- it changes when someone fixes a typo.
  - typestringrequired
  - requiredbooleanrequired
  - optionsarray of object
    Present on select-type questions only.
    - idstringrequired
    - labelstringrequired
    - valuestringrequired
  - configobjectrequired
    Whatever type-specific options the question carries beyond `type` and `options`. Two are required, not defaulted: `min` and `max` on a `scale` question (e.g. 1 and 10), and `currency` on a `money` question. A `scale` range spans at most 10 (11 buttons); the widget draws one button per integer and the row cannot wrap.
eflowIdstringrequired
A eflow id, prefixed `eflow_`.
versionintegerrequired

400The request was malformed or failed validation.

errorobjectrequired
- type"invalid_request_error" | "authentication_error" | "permission_error" | "not_found_error" | "idempotency_error" | "rate_limit_error" | "api_error"required
  The bucket a client branches on to decide how to react.
- codestringrequired
  Stable machine-readable code. Branch on this, not on `message`.
- messagestringrequired
  Human-readable. May change without notice.
- paramstring
  The offending request field, when the error names one.
- requestIdstringrequired
  Echoes the `req_...` id; quote it in support requests.

401Missing, invalid, or revoked credential.

errorobjectrequired
- type"invalid_request_error" | "authentication_error" | "permission_error" | "not_found_error" | "idempotency_error" | "rate_limit_error" | "api_error"required
  The bucket a client branches on to decide how to react.
- codestringrequired
  Stable machine-readable code. Branch on this, not on `message`.
- messagestringrequired
  Human-readable. May change without notice.
- paramstring
  The offending request field, when the error names one.
- requestIdstringrequired
  Echoes the `req_...` id; quote it in support requests.

403The credential lacks the scope this route requires.

errorobjectrequired
- type"invalid_request_error" | "authentication_error" | "permission_error" | "not_found_error" | "idempotency_error" | "rate_limit_error" | "api_error"required
  The bucket a client branches on to decide how to react.
- codestringrequired
  Stable machine-readable code. Branch on this, not on `message`.
- messagestringrequired
  Human-readable. May change without notice.
- paramstring
  The offending request field, when the error names one.
- requestIdstringrequired
  Echoes the `req_...` id; quote it in support requests.

404No such resource, or it belongs to another tenant.

errorobjectrequired
- type"invalid_request_error" | "authentication_error" | "permission_error" | "not_found_error" | "idempotency_error" | "rate_limit_error" | "api_error"required
  The bucket a client branches on to decide how to react.
- codestringrequired
  Stable machine-readable code. Branch on this, not on `message`.
- messagestringrequired
  Human-readable. May change without notice.
- paramstring
  The offending request field, when the error names one.
- requestIdstringrequired
  Echoes the `req_...` id; quote it in support requests.

429Rate limited. Retry after the interval in `Retry-After`.

errorobjectrequired
- type"invalid_request_error" | "authentication_error" | "permission_error" | "not_found_error" | "idempotency_error" | "rate_limit_error" | "api_error"required
  The bucket a client branches on to decide how to react.
- codestringrequired
  Stable machine-readable code. Branch on this, not on `message`.
- messagestringrequired
  Human-readable. May change without notice.
- paramstring
  The offending request field, when the error names one.
- requestIdstringrequired
  Echoes the `req_...` id; quote it in support requests.

500Something failed on our side. Safe to retry.

errorobjectrequired
- type"invalid_request_error" | "authentication_error" | "permission_error" | "not_found_error" | "idempotency_error" | "rate_limit_error" | "api_error"required
  The bucket a client branches on to decide how to react.
- codestringrequired
  Stable machine-readable code. Branch on this, not on `message`.
- messagestringrequired
  Human-readable. May change without notice.
- paramstring
  The offending request field, when the error names one.
- requestIdstringrequired
  Echoes the `req_...` id; quote it in support requests.

Browse every operation, with full request/response schemas, in the full API reference.