Skip to main content
GET
List Forms
Returns the metadata for every form Cobalt has cached for your account — id, name, type, version, and status. The full form definition (categories, questions, answers) is not included here; fetch it for a single form with GET /v1/forms/{id}. Forms are cached by a sync. Trigger an on-demand refresh with POST /v1/forms/fetch; a daily scheduler also keeps the cache current.
Forms are currently supported for Credible.

When to use this

Use the list to find the form you want to document a service with. The emr_form_id of the chosen form is the form_id you pass to POST /v1/services. Then read that form’s definition to get the question ids for the service answers.

Example Request

Example Response

The fields on each form:
  • id: Cobalt form id (UUID). Use this with GET /v1/forms/{id}.
  • emr_form_id: The form’s id in the EMR. This is the form_id you pass to POST /v1/services.
  • emr_fvid: The EMR form-version id, or null.
  • name: Form name.
  • type, version, status, build_date: Form metadata from the EMR (any may be null).
  • synced_at: When the form was last synced into the cache.

Authorizations

client_id
string
header
required
client_secret
string
header
required
access_token
string
header
required

Response

Cached form metadata for the account

success
boolean
forms
object[]