Retrieve a Form

GET

/businesses/{businessId}/forms/{formId}

const url = 'https://api.upvio.com/v1/businesses/example/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.upvio.com/v1/businesses/example/forms/example \
  --header 'Authorization: Bearer <token>'

Retrieve a Form by ID.

Authorizations

apiKey

Parameters

Path Parameters

businessId

required

The ID of the Business.

string

formId

required

The ID of the Form.

string

Responses

200

A Form.

application/json

object

data

Form

A form to collect data from users.

object

required

Unique identifier across the platform.

string format: uuid

alias

required

The unique alias of the form.

string

title

required

The title of the form.

string

description

The description of the form.

string

nullable

category

The category of the form.

string

nullable

visibility

The visibility of the form.

string

Allowed values: LISTED UNLISTED

submissionsCount

The total number of submissions for the form.

integer

unreadSubmissionsCount

The number of unread submissions for the form.

integer

publishedAt

The date and time when the form was published.

string format: date-time

nullable

createdAt

required

Time when the resource was created (ISO 8601 format).

string format: date-time

updatedAt

required

Time when the resource was last updated (ISO 8601 format).

string format: date-time

url

The URL to access the form.

string

status

required

The current status of the form.

string

Allowed values: Draft Published PublishedWithDraft

steps

The steps that make up this form.

Array<object>

object

draft

The draft version of the form, if available.

object

Unique identifier across the platform.

string format: uuid

steps

The steps that make up the draft form.

Array<object>

object

Example

{
  "data": {
    "alias": "booking-form",
    "title": "Booking Form",
    "description": "Default form used for appointment bookings.",
    "category": "General Practice",
    "visibility": "LISTED",
    "status": "Draft"
  }
}

400

The form ID is malformed.

application/json

object

error

object

code

number

type

The specific error that occurred.

string

Allowed values: BadRequestError

title

Human-readable description of the error.

string

Example

{
  "error": {
    "code": 400,
    "type": "BadRequestError",
    "title": "Invalid platformId format."
  }
}

403

The API key is missing or invalid, or the Business cannot be accessed with it.

application/json

object

error

object

code

number

type

The specific error that occurred.

string

Allowed values: UnauthorizedError BusinessArchivedError BusinessDisabledError

title

Human-readable description of the error.

string

Example

{
  "error": {
    "code": 403,
    "type": "UnauthorizedError",
    "title": "Invalid API token"
  }
}

404

The form does not exist.

application/json

object

error

object

code

number

type

The specific error that occurred.

string

Allowed values: NotFoundError BusinessNotFoundError

title

Human-readable description of the error.

string

Example

{
  "error": {
    "code": 404,
    "type": "NotFoundError",
    "title": "Form not found"
  }
}