Home > Agendize Scheduling

Scheduling Forms


Resource representation

{ "id": {string}, "author": {string}, "name": {string}, "fields": [ { "id": {string}, "type": {string}, "label": {string}, "help": {string}, "mandatory": {boolean}, "order": {integer}, "values" : [{string}], "visible" : {boolean} } ] }
Parameter name Value Description
id string Identifier of the form's company.
author string Author of the form.
name string Name of the form.
fields[] string Fields of the form.
fields[].id string Id of the fields.
fields[].type string Type of the field. Values:
  • "1": input text
  • "2": dropdown
  • "3": check box
  • "4": section title
  • "5": page break
  • "6": textaera
  • "7": file upload
  • "8": language choice
  • "9": client reference identifier
  • "10": type of notifications
  • "11": additionnel client email addresses for notifications
  • "12": reminder types
  • "13": client: street address
  • "14": client: additional street address
  • "15": client: zip code
  • "16": client: city
  • "17": client: country
  • "18": client: state
  • "20": client: title
  • "21": client: company of client
  • "19": date
fields[].label string Label of the field.
fields[].help string Help text of the field.
fields[].mandatory boolean If the field is mandatory.
fields[].order integer Order number of the fields. First field of the form has order number 1.
fields[].values string Values list of the field.
fields[].visible boolean If the field is visible by client.

Get

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET https://api.agendize.com/api/2.0/scheduling/forms/{companyId}

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a Form resource in the response body.


List

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET https://api.agendize.com/api/2.0/scheduling/forms

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{ items: [Form Resource] }