infoodle

Get a specific form by ID

GET /form/{id}
O auth2

Returns details of a specific form that the user has access to

Path parameters

  • id integer Required

    Which item to be processed

    Minimum value is 0.

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • id integer

      The unique form ID

    • url string
    • title string

      The title of the form for the user to select

    • active integer

      The status of the form 1: Active 0: Not Active -1: Deleted

      Values are -1, 0, or 1.

    • form_active_from_utc string

      The time this form becomes active - UTC. Format YYYY-MM-DD HH:NN:SS

    • form_active_to_utc string

      The time this form stops being active - UTC. Format YYYY-MM-DD HH:NN:SS
  • 401 application/json

    Authentication unauthorised

    Hide response attribute Show response attribute object
    • error string
  • 403 application/json

    Invalid permission

    Hide response attribute Show response attribute object
    • error string
  • 404 application/json

    Not Found

    Hide response attribute Show response attribute object
    • error string
GET /form/{id} 
curl \
 --request GET 'https://YOURSITE.infoodle.com/apiv2/form/99' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "id": 12345,
  "url": "https://demo.infoodle.com/form_process?g=8dd5de45-6f51-48fc-8e77-f4a428158f71",
  "title": "Registration form",
  "active": -1,
  "form_active_from_utc": "2022-06-01 15:00:00",
  "form_active_to_utc": "2022-06-30 15:00:00"
}
Response examples (401) 
{
  "error": "Unauthorised"
}
Response examples (403) 
{
  "error": "Invalid Permission"
}
Response examples (404) 
{
  "error": "Not Found"
}