Forms

Forms allow agents to fill out information about each contact.

Fields

class Form

created_at: datetime: The form’s creation date and time.

description: string: The form’s description.

id: integer: The form’s unique ID.

name: string: The form’s name.

team: integer: The form’s team.

API

GET /j/forms

Retrieves the list of forms.

Example request:

GET /j/forms HTTP/1.1
Authorization: Bearer 0a1b2c3d4e5f

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

[
   {
      "created_at": "2016-11-04T19:11:34.985Z",
      "description": "Some description",
      "id": 1,
      "name": "First form",
      "team": 1
   },
   {
      "created_at": "2016-11-04T19:13:46.246Z",
      "description": "Other description",
      "id": 2,
      "name": "Second form",
      "team": 1
   }
]

Request Headers:

Authorization – OAuth token to authenticate

Query Parameters:

team (integer) – An optional team ID.

Response JSON Array of Objects:

created_at (datetime) – The form’s creation date and time.
description (string) – The form’s description.
id (integer) – The form’s unique ID.
name (string) – The form’s name.
team (integer) – The form’s team.

Status Codes:

200 OK – no error
400 Bad Request – for instance a required field is missing
403 Forbidden – you tried to access a forbidden resource, check you provided a valid OAuth token