Get a form

GET

/forms/v1/sdk/forms/{formExternalId}

const url = 'https://api.ebitex.io/forms/v1/sdk/forms/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.ebitex.io/forms/v1/sdk/forms/example \
  --header 'Authorization: Bearer <token>'

Returns one form, by the External ID set in the Forms editor, with its fields and steps fully resolved for the request’s Accept-Language. It includes a submissionUrl to post answers to and a submittable flag, which is false for a draft.

Submit every answer under the field’s submissionKey, never its display name. Call this from your server: the key acts for your whole organization and must never reach a browser. @ebitex/forms-sdk renders the result.

Key: a Forms SDK key with forms.sdk.forms.read.

Authorizations

apiKey

Parameters

Path Parameters

formExternalId

required

string

Responses

200

401

missing_api_key or invalid_api_key: no key was sent, or it is unknown, revoked or expired.

402

payment_required: the organization’s subscription needs attention.

403

scope_denied: the key lacks forms.sdk.forms.read. ip_denied: the caller’s address is outside the key’s allowed ranges.

404

No form has this External ID in the organization.

409

submission_key_clash: two fields share a submission key. clashingKeys names them; fix it in the Forms editor.

429

Rate limit or per-minute quota exceeded; Retry-After says how long to wait. too_many_failed_authentications: too many bad keys from this address.