GET
/
v1.0
/
{company_id}
/
forms
/
application
curl --request GET \
  --url https://api.hirehive.com/v1.0/{company_id}/forms/application \
  --header 'Authorization: Bearer <token>'
{
  "meta": {
    "page_size": 123,
    "page": 123,
    "total_items": 123,
    "total_pages": 123,
    "has_next_page": true,
    "has_previous_page": true
  },
  "links": {
    "first": "<string>",
    "last": "<string>",
    "next": "<string>",
    "previous": "<string>"
  },
  "items": [
    {
      "questions": [
        {
          "id": "<string>",
          "type": "textbox",
          "question": "<string>",
          "description": "<string>",
          "options": [
            {
              "id": "<string>",
              "label": "<string>",
              "description": "<string>",
              "tag": {
                "id": "<string>",
                "name": "<string>"
              },
              "archived": true
            }
          ],
          "required": true,
          "restricted": true,
          "archived": true,
          "display_order": 123
        }
      ],
      "id": "<string>",
      "name": "<string>",
      "type": "application_questions",
      "used_in": 123
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
company_id
string
required

Query Parameters

​
type
enum<string>
Available options:
application_questions,
follow_up_questions,
feedback_form
​
include_archived_questions_and_options
boolean

Include archived questions and options in the response

​
page
integer

Defaults to 1

​
page_size
integer

Defaults to 30. Min = 1. Max = 100

Required range: 1 <= x <= 100

Response

200
application/json
​
meta
object
​
links
object
​
items
object[]

Was this page helpful?

Suggest editsRaise issue