brand-logo

Introduction

Welcome to the Likeable Forms API Reference site. Use the Likeable Forms API to create forms, notifications, submissions, and more and seamlessly integrate your product/service with the Likeable Forms form builder.

Getting started

To get started, you will need to obtain your Likeable Forms API key. The API uses standard HTTP response codes, authentication, and returns json encoded responses.

Get your API key

Quickstart

This guide will get you all set up and ready to use the Likeable Forms API. We'll cover how to get started using one of our API examples to make your first API request. We'll also look at where to go next to find all the information you need to take full advantage of our powerful REST API.

Before you can make requests to the Likeable Forms API, you will need to grab your API key from your account dashboard. You find it by logging in to your account, clicking "API Key", then "Reveal API Key".

Making your first API request

After locating your API Key, you are ready to make your first call to the Likeable Forms API. Below, you can see how to send a GET request to the Form Ids enpoint to get the Id for a single form. In the cURL example, a json encoded response will be returned containing the form Id.

GET
/connect/api/v1/formid
curl  --location 'https://likeableforms.com/connect/api/v1/formid?title=Contact' \
  --header 'X: {apikey}' \
  --data ''

Authentication

You'll need to authenticate your requests to access any of the endpoints in the Likeable Forms API. In this guide, we'll look at how authentication works. Likeable Forms offers one way to authenticate your API requests: API Key authentication.

API Key authentication

To authenticate your HTTP requests with API Key authentication, you will use X as the key and your API Key for the value. Here's how to authenticate using cURL:

Example request with API Key auth

curl https://likeableforms.com/connect/api/forms \
  --header 'X: {apikey}' \

Please don't commit your Likeable Forms API Key to GitHub or share it publicly!

Errors

In this guide, we will talk about what happens when something goes wrong while you work with the API. Let's look at some of the error types you might encounter.

Error Response Properties

Whenever a request is unsuccessful, the Likeable Forms API will return an error response with an error type and message. You can use this information to understand better what has gone wrong and how to fix it. Most of the error messages are pretty helpful and actionable.

Here is a list of errors types you may encounter — use these to understand what needs to be corrected.

  • Name
    error_found
    Description

    This means that we found an error with your API call and will provide a response in order to suggest a possible solution.

  • Name
    error_message
    Description

    This is a message that contains a possible solution to address the error found with your API call.

Error response

{
  "error_found": "true",
  "error_message": "Invalid Form Id"
}
GET /connect/api/v1/form

Get Form

This endpoint allows you to retrieve a single form.

Required Parameters

  • Name
    id
    Type
    parameter
    Description

    Isolates individual form by id.

Response

  • Name
    id
    Type
    integer
    Description

    The form id.

  • Name
    title
    Type
    string
    Description

    The form title.

  • Name
    description
    Type
    string
    Description

    The form description.

  • Name
    fields
    Type
    associative array
    Description

    The fields array.

  • Name
    fieldType
    Type
    string
    Description

    Unique identifier for the field.

  • Name
    labelContent
    Type
    string
    Description

    The fields input label.

  • Name
    helperContent
    Type
    string
    Description

    The fields input description.

  • Name
    currentIncrement
    Type
    string
    Description

    The current id of the field.

  • Name
    currentCounter
    Type
    string
    Description

    The current counter for the field.

  • Name
    required
    Type
    string
    Description

    The required attribute that determines if the field is set to required.

  • Name
    hidden
    Type
    string
    Description

    If the field is hidden.

  • Name
    placeholder
    Type
    string
    Description

    The placeholder/helper text for the field.

  • Name
    min
    Type
    string
    Description

    The minimum length required for the field.

  • Name
    max
    Type
    string
    Description

    The maximum length required for the field.

  • Name
    regex
    Type
    string
    Description

    The regular expression used for server-side validation. Defaults to pending generation.

  • Name
    value
    Type
    string
    Description

    The current fields pre-defined value. Defaults to pending generation.

  • Name
    logicEnabled
    Type
    string
    Description

    If the field has logic enabled. Defaults to pending generation.

  • Name
    logic
    Type
    array
    Description

    The logic JSON. Defaults to empty.

Request

GET
/connect/api/v1/form
curl --location 'https://likeableforms.com/connect/api/v1/form' \
--header 'X: {apikey}' \
--data ''

Response

{
  "id": 1,
  "title": "Contact",
  "description": "Get in touch.",
  "fields": [
      {
          "fieldType": "lfAddEmail",
          "labelContent": "Email Address",
          "helperContent": "Please enter a valid email address.",
          "currentIncrement": "1",
          "currentCounter": "1",
          "required": "true",
          "hidden": "false",
          "placeholder": emailaddress@url.com,
          "min": "0",
          "max": "126",
          "regex": "pending generation",
          "value": "pending generation"
          "logicEnabled": "pending generation",
          "logic": []
       }
    ]
}
POST /connect/api/v1/form

Create Form

This endpoint allows you to create a single form.

Required

  • Name
    title
    Type
    string
    Description

    The form title.

  • Name
    description
    Type
    string
    Description

    The form description.

  • Name
    fields
    Type
    associative array
    Description

    Requires a minimum of 5 key value pairs.

  • Name
    fieldType
    Type
    string
    Description

    Unique identifier for the field.

  • Name
    labelContent
    Type
    string
    Description

    The fields input label.

  • Name
    helperContent
    Type
    string
    Description

    The fields input description.

  • Name
    required
    Type
    string
    Description

    The required attribute that determines if the field is set to required.

  • Name
    placeholder
    Type
    string
    Description

    The placeholder/helper text for the field.

Optional

  • Name
    currentIncrement
    Type
    string
    Description

    The current id of the field.

  • Name
    currentCounter
    Type
    string
    Description

    The current counter for the field.

  • Name
    hidden
    Type
    string
    Description

    If the field is hidden.

  • Name
    min
    Type
    string
    Description

    The minimum length required for the field.

  • Name
    max
    Type
    string
    Description

    The maximum length required for the field.

  • Name
    regex
    Type
    string
    Description

    The regular expression used for server-side validation. Defaults to pending generation.

  • Name
    value
    Type
    string
    Description

    The current fields pre-defined value. Defaults to pending generation.

  • Name
    logicEnabled
    Type
    string
    Description

    If the field has logic enabled. Defaults to pending generation.

  • Name
    logic
    Type
    array
    Description

    The logic JSON. Defaults to empty.

Response

  • Name
    id
    Type
    string
    id

    The id of the form.

  • Name
    link
    Type
    string
    Description

    The URL for the form.

Request

POST
/connect/api/v1/form
curl --location 'https://likeableforms.com/connect/api/v1/form?id=1' \
--header 'Content-Type: application/json' \
--header 'X: {apikey}' \
--data-raw '{
     "title": "Contact",
     "description": "Get in touch.",
     "fields": [
        {
          "fieldType": "lfAddEmail",
          "labelContent": "Email Address",
          "helperContent": "Please enter a valid email address.",
          "required": "true",
          "placeholder": "emailaddress@url.com"
        }
    ]
}'

Response

{
  "id": 1,
  "link": "https://likeableforms.com/link?f=1"
}
PUT /connect/api/v1/form

Update a form

This endpoint allows you to create a single form.

Required Parameters

  • Name
    id
    Type
    parameter
    Description

    Isolates individual form by id.

Required

  • Name
    title
    Type
    string
    Description

    The form title.

  • Name
    description
    Type
    string
    Description

    The form description.

  • Name
    fields
    Type
    associative array
    Description

    Requires a minimum of 5 key value pairs.

  • Name
    fieldType
    Type
    string
    Description

    Unique identifier for the field.

  • Name
    labelContent
    Type
    string
    Description

    The fields input label.

  • Name
    helperContent
    Type
    string
    Description

    The fields input description.

  • Name
    required
    Type
    string
    Description

    The required attribute that determines if the field is set to required.

  • Name
    placeholder
    Type
    string
    Description

    The placeholder/helper text for the field.

Optional

  • Name
    currentIncrement
    Type
    string
    Description

    The current id of the field.

  • Name
    currentCounter
    Type
    string
    Description

    The current counter for the field.

  • Name
    hidden
    Type
    string
    Description

    If the field is hidden.

  • Name
    min
    Type
    string
    Description

    The minimum length required for the field.

  • Name
    max
    Type
    string
    Description

    The maximum length required for the field.

  • Name
    regex
    Type
    string
    Description

    The regular expression used for server-side validation. Defaults to pending generation.

  • Name
    value
    Type
    string
    Description

    The current fields pre-defined value. Defaults to pending generation.

  • Name
    logicEnabled
    Type
    string
    Description

    If the field has logic enabled. Defaults to pending generation.

  • Name
    logic
    Type
    array
    Description

    The logic JSON. Defaults to empty.

Response

  • Name
    updated
    Type
    boolean
    Description

    Status of the update.

Request

PUT
/connect/api/v1/form
curl --location 'https://likeableforms.com/connect/api/v1/form?id=1' \
--header 'Content-Type: application/json' \
--header 'X: {apikey}' \
--data-raw '{
     "title": "Contact",
     "description": "Get in touch.",
     "fields": [
        {
          "fieldType": "lfAddEmail",
          "labelContent": "Email Address",
          "helperContent": "Please enter a valid email address.",
          "required": "true",
          "placeholder": emailaddress@url.com
        }
    ]
}'

Response

{
  "updated": true
}
PUT /connect/api/v1/forms

Duplicate a form

This endpoint allows you to duplicate a single form.

Required Parameters

  • Name
    id
    Type
    parameter
    Description

    Isolates individual form by id.

Required

  • Name
    title
    Type
    string
    Description

    The name for the duplicated form title.

  • Name
    notifications
    Type
    string
    Description

    Duplicate notifications.

Response

  • Name
    updated
    Type
    boolean
    Description

    Status of the update.

Request

PUT
/connect/api/v1/forms
curl --location 'https://likeableforms.com/connect/api/v1/forms?id=1' \
--header 'Content-Type: application/json' \
--header 'X: {apikey}' \
--data-raw '{
     "title": "Duplicated Contact",
     "notifications": "true"
}'

Response

{
  "updated": true
}
DELETE /connect/api/v1/form

Delete a form

This endpoint allows you to delete a form from your account

Required Parameters

  • Name
    id
    Type
    parameter
    Description

    Isolates individual form by id.

Response

  • Name
    deleted
    Type
    boolean
    Description

    Status of the update.

Request

DELETE
/connect/api/v1/form
curl --location --request DELETE 'https://likeableforms.com/connect/api/v1/form?id=1' \
--header 'X: {apikey}' \

Response

{
  "deleted": true,
}
GET /connect/api/v1/submission

Get Submission

This endpoint allows you to retrieve a single submission.

Required Parameters

  • Name
    submission-id
    Type
    parameter
    Description

    Isolates individual submission by id.

Response

  • Name
    fieldType
    Type
    string
    Description

    Unique identifier for the field.

  • Name
    currentIncrement
    Type
    integer
    Description

    The current id of the field.

  • Name
    currentCounter
    Type
    integer
    Description

    The current counter id of the field.

  • Name
    required
    Type
    string
    Description

    The required attribute that determines if the field is set to required.

  • Name
    labelContent
    Type
    string
    Description

    The fields input label.

  • Name
    value
    Type
    string
    Description

    The current fields pre-defined value.

  • Name
    month
    Type
    string
    Description

    The date of the submission.

  • Name
    time
    Type
    string
    Description

    The time of the submission.

Request

GET
/connect/api/v1/submission
curl --location 'https://likeableforms.com/api/connect/v1/submission?submission-id=1' \
--header 'X: {apikey}' \
--data ''

Response

{
    "fieldType": "lfAddEmail",
    "currentIncrement": "1",
    "currentCounter": "1",
    "required": "true",
    "labelContent": "Email Address",
    "value": "emailaddress@url.com"
    "month": "03-31-2024",
    "time": "07:30 am"
}
POST /connect/api/v1/submission

Create Submission

This endpoint allows you to create a single submission.

Required

  • Name
    submission
    Type
    associative array
    Description

    Requires 7 key value pairs.

  • Name
    fieldType
    Type
    string
    Description

    Unique identifier for the field.

  • Name
    required
    Type
    string
    Description

    The required attribute that determines if the field is set to required.

  • Name
    labelContent
    Type
    string
    Description

    The fields input label.

  • Name
    value
    Type
    string
    Description

    The datestamp of the submission.

  • Name
    month
    Type
    string
    Description

    The timestamp of the submission.

Response

  • Name
    id
    Type
    string
    id

    The id of the submisison.

Request

POST
/connect/api/v1/submission
curl --location 'https://likeableforms.com/connect/api/v1/submission' \
--header 'Content-Type: application/json' \
--header 'X: {apikey}' \
--data-raw '{
  "submission": [
      {
          "fieldType": "lfAddEmail",
          "currentIncrement": "1",
          "required": "true",
          "labelContent": "Email Address",
          "value": "emailaddress@url.com",
          "month": 03-31-2024,
          "time": "07:30am"
      }
   ]
}'

Response

{
  "id": 1,
}
PUT /connect/api/v1/submission

Update a submission

This endpoint allows you to update a single submission.

Required Parameters

  • Name
    submission-id
    Type
    parameter
    Description

    Isolates individual submission by id.

Required

  • Name
    submission
    Type
    associative array
    Description

    Requires 7 key value pairs.

  • Name
    fieldType
    Type
    string
    Description

    Unique identifier for the field.

  • Name
    required
    Type
    string
    Description

    The required attribute that determines if the field is set to required.

  • Name
    labelContent
    Type
    string
    Description

    The fields input label.

  • Name
    value
    Type
    string
    Description

    The datestamp of the submission.

  • Name
    month
    Type
    string
    Description

    The timestamp of the submission.

Response

  • Name
    updated
    Type
    boolean
    Description

    Status of the update.

Request

PUT
/connect/api/v1/submission
curl --location 'https://likeableforms.com/connect/api/v1/submission?submission=id=1' \
--header 'Content-Type: application/json' \
--header 'X: {apikey}' \
--data-raw '{
  "submission": [
      {
          "fieldType": "lfAddEmail",
          "currentIncrement": "1",
          "required": "true",
          "labelContent": "Email Address",
          "value": "emailaddress@url.com",
          "month": 03-31-2024,
          "time": "07:30 am"
      }
   ]
}'

Response

{
  "updated": true
}
DELETE /connect/api/v1/submission

Delete a submission

This endpoint allows you to delete a submission from your account.

Required Parameters

  • Name
    submission-id
    Type
    parameter
    Description

    Isolates individual submission by id.

Response

  • Name
    deleted
    Type
    boolean
    Description

    Status of the update.

Request

DELETE
/connect/api/v1/submission
curl --location --request DELETE 'https://likeableforms.com/connect/api/v1/submission?submission-id=1' \
--header 'X: {apikey}' \

Response

{
  "deleted": true,
}
GET /connect/api/v1/notification

Get Notification

This endpoint allows you to retrieve a single notification.

Required Parameters

  • Name
    id
    Type
    parameter
    Description

    Isolates individual notification by form id.

Response

  • Name
    from
    Type
    string
    Description

    Name or company name.

  • Name
    to
    Type
    array
    Description

    The id or ids of email fields in the form.

  • Name
    replyto
    Type
    string
    Description

    The replyto email address.

  • Name
    subject
    Type
    string
    Description

    The notification subject.

  • Name
    bcc
    Type
    array
    Description

    The id or ids of email fields in the form.

  • Name
    body
    Type
    string
    Description

    The notification message. Supports HTML.

  • Name
    attach_uploads
    Type
    string
    Description

    Determines if notification should include file uploads.

Request

GET
/connect/api/v1/notification
curl --location 'https://likeableforms.com/api/connect/v1/notification?id=1' \
--header 'X: {apikey}' \
--data ''

Response

{
    "from": "Company Name",
    "to": ["1", "5"],
    "replyto": "replies@address.com",
    "subject": "Email Subject",
    "bcc": ["2", "4"],
    "body": "This is the message body."
    "attach_uploads": "true",
}
POST /connect/api/v1/notification

Create notification

This endpoint allows you to create a single notification.

Required Parameters

  • Name
    id
    Type
    parameter
    Description

    Isolates individual notification by form id.

Required

  • Name
    from
    Type
    string
    Description

    Name or company name.

  • Name
    to
    Type
    array
    Description

    The id or ids of email fields in the form.

  • Name
    replyto
    Type
    string
    Description

    The replyto email address.

  • Name
    bcc
    Type
    string
    Description

    The id or ids of email fields in the form.

  • Name
    body
    Type
    string
    Description

    The notification message. Supports HTML.

  • Name
    attach_uploads
    Type
    string
    Description

    Determines if notification should include file uploads.

Response

  • Name
    id
    Type
    string
    id

    The id of the notification.

Request

POST
/connect/api/v1/notification
curl --location 'https://likeableforms.com/connect/api/v1/notification?id=1' \
--header 'Content-Type: application/json' \
--header 'X: {apikey}' \
--data-raw '{
    "from": "Company Name",
    "to": ["1", "5"],
    "replyto": "replies@address.com",
    "subject": "Email Subject",
    "bcc": ["2", "4"],
    "body": "This is the message body",
    "attach_uploads": "true"
}'

Response

{
  "id": 1,
}
PUT /connect/api/v1/submission

Update Notification

This endpoint allows you to create a single notification.

Required Parameters

  • Name
    id
    Type
    parameter
    Description

    Isolates individual notification by form id.

Required

  • Name
    from
    Type
    string
    Description

    Name or company name.

  • Name
    to
    Type
    array
    Description

    The id or ids of email fields in the form.

  • Name
    replyto
    Type
    string
    Description

    The replyto email address.

  • Name
    bcc
    Type
    string
    Description

    The id or ids of email fields in the form.

  • Name
    body
    Type
    string
    Description

    The notification message. Supports HTML.

  • Name
    attach_uploads
    Type
    string
    Description

    Determines if notification should include file uploads.

Response

  • Name
    id
    Type
    string
    id

    The id of the notification.

Request

PUT
/connect/api/v1/notification
curl --location 'https://likeableforms.com/connect/api/v1/notification?id=1' \
--header 'Content-Type: application/json' \
--header 'X: {apikey}' \
--data-raw '{
    "from": "Company Name",
    "to": ["1", "5"],
    "replyto": "replies@address.com",
    "subject": "Email Subject",
    "bcc": ["2", "4"],
    "body": "This is the message body",
    "attach_uploads": "true"
}'

Response

{
  "updated": "true,
}
DELETE /connect/api/v1/notification

Delete Notification

This endpoint allows you to delete a notification from your account.

Required Parameters

  • Name
    id
    Type
    parameter
    Description

    Isolates individual notification by form id.

Response

  • Name
    deleted
    Type
    boolean
    Description

    Status of the update.

Request

DELETE
/connect/api/v1/notification
curl --location --request DELETE 'https://likeableforms.com/connect/api/v1/notification?id=1' \
--header 'X: {apikey}' \

Response

{
  "deleted": true,
}
GET /connect/api/v1/link

Get File Upload

This endpoint allows you to retrieve a single link.

Required Parameters

  • Name
    id
    Type
    parameter
    Description

    Isolates individual link by form id.

Response

  • Name
    link
    Type
    string
    Description

    The link for the form.

Request

GET
/connect/api/v1/link
curl --location 'https://likeableforms.com/connect/api/v1/link?id=1' \
--header 'X: {apikey}' \
--data ''

Response

{
    "link": "https://likeableforms.com/link?f=1"
}
GET /connect/api/v1/links

Get File Uploads

This endpoint allows you to retrieve all links associated with account.

Response

  • Name
    id
    Type
    string
    Description

    The id of the form.

  • Name
    title
    Type
    string
    Description

    The title of the form.

  • Name
    link
    Type
    string
    Description

    The link for the form.

Request

GET
/connect/api/v1/links
curl --location 'https://likeableforms.com/connect/api/v1/links' \
--header 'X: {apikey}' \
--data ''

Response

[
   {
      "id": "1",
      "title": "Contact",
      "link": "https://likeableforms.com/link?f=14
   }
]
GET /connect/api/v1/links

Upload File

This endpoint allows you to retrieve all links associated with account.

Response

  • Name
    id
    Type
    string
    Description

    The id of the form.

  • Name
    title
    Type
    string
    Description

    The title of the form.

  • Name
    link
    Type
    string
    Description

    The link for the form.

Request

GET
/connect/api/v1/links
curl --location 'https://likeableforms.com/connect/api/v1/links' \
--header 'X: {apikey}' \
--data ''

Response

[
   {
      "id": "1",
      "title": "Contact",
      "link": "https://likeableforms.com/link?f=14
   }
]
GET /connect/api/v1/files

Upload Files

This endpoint allows you to retrieve all files associated with a form.

Response

  • Name
    id
    Type
    string
    Description

    The id of the form.

  • Name
    title
    Type
    string
    Description

    The title of the form.

  • Name
    link
    Type
    string
    Description

    The link for the form.

Request

GET
/connect/api/v1/links
curl --location 'https://likeableforms.com/connect/api/v1/links' \
--header 'X: {apikey}' \
--data ''

Response

[
   {
      "id": "1",
      "title": "Contact",
      "link": "https://likeableforms.com/link?f=14
   }
]
GET /connect/api/v1/link

Get Field Types

This endpoint allows you to retrieve a single link.

Required Parameters

  • Name
    id
    Type
    parameter
    Description

    Isolates individual link by form id.

Response

  • Name
    link
    Type
    string
    Description

    The link for the form.

Request

GET
/connect/api/v1/link
curl --location 'https://likeableforms.com/connect/api/v1/link?id=1' \
--header 'X: {apikey}' \
--data ''

Response

{
    "link": "https://likeableforms.com/link?f=1"
}

Update Fields

This endpoint allows you to retrieve all links associated with account.

Response

  • Name
    id
    Type
    string
    Description

    The id of the form.

  • Name
    title
    Type
    string
    Description

    The title of the form.

  • Name
    link
    Type
    string
    Description

    The link for the form.

Request

GET
/connect/api/v1/links
curl --location 'https://likeableforms.com/connect/api/v1/links' \
--header 'X: {apikey}' \
--data ''

Response

[
   {
      "id": "1",
      "title": "Contact",
      "link": "https://likeableforms.com/link?f=14
   }
]

Duplicate Fields

This endpoint allows you to retrieve all links associated with account.

Response

  • Name
    id
    Type
    string
    Description

    The id of the form.

  • Name
    title
    Type
    string
    Description

    The title of the form.

  • Name
    link
    Type
    string
    Description

    The link for the form.

Request

GET
/connect/api/v1/links
curl --location 'https://likeableforms.com/connect/api/v1/links' \
--header 'X: {apikey}' \
--data ''

Response

[
   {
      "id": "1",
      "title": "Contact",
      "link": "https://likeableforms.com/link?f=14
   }
]

Delete Fields

This endpoint allows you to retrieve all files associated with a form.

Response

  • Name
    id
    Type
    string
    Description

    The id of the form.

  • Name
    title
    Type
    string
    Description

    The title of the form.

  • Name
    link
    Type
    string
    Description

    The link for the form.

Request

GET
/connect/api/v1/links
curl --location 'https://likeableforms.com/connect/api/v1/links' \
--header 'X: {apikey}' \
--data ''

Response

[
   {
      "id": "1",
      "title": "Contact",
      "link": "https://likeableforms.com/link?f=14
   }
]
GET /connect/api/v1/formid

Get Form Id

This endpoint allows you to retrieve a single form id.

Required Parameters

  • Name
    title
    Type
    parameter
    Description

    Isolates individual form by form title.

Response

  • Name
    id
    Type
    string
    Description

    The id of the form.

Request

GET
/connect/api/v1/formid
curl --location 'https://likeableforms.com/connect/api/v1/formid?title=Contact' \
--header 'X: {apikey}' \
--data ''

Response

{
  "id": "1",
}
GET /connect/api/v1/formids

Get Form Ids

This endpoint allows you to retrieve all form ids associated with account.

Response

  • Name
    title
    Type
    string
    Description

    The title of the form.

  • Name
    id
    Type
    string
    Description

    The id of the form.

Request

GET
/connect/api/v1/formids
curl --location 'https://likeableforms.com/connect/api/v1/formids?id=1' \
--header 'X: {apikey}' \
--data ''

Response

[
  {
    "title": "Contact",
    "id": "1"
  }
]
GET /connect/api/v1/submissionids

Get Submission Ids

This endpoint allows you to retrieve all submission ids associated with a form.

Required Parameters

  • Name
    id
    Type
    parameter
    Description

    Isolates submission ids by form id.

Response

  • Name
    title
    Type
    string
    Description

    The title of the form.

  • Name
    id
    Type
    string
    Description

    The id of the submission.

Request

GET
/connect/api/v1/submissionids
curl --location 'https://likeableforms.com/connect/api/v1/submission?id=1' \
--header 'X: {apikey}' \
--data ''

Response

[
  {
    "title": "Contact",
    "id": "1"
  }
]
GET /connect/api/v1/title

Get Form Title

This endpoint allows you to retrieve a single form title.

Required Parameters

  • Name
    id
    Type
    parameter
    Description

    Isolates individual title by form id.

Response

  • Name
    title
    Type
    string
    Description

    The title for the form.

Request

GET
/connect/api/v1/title
curl --location 'https://likeableforms.com/connect/api/v1/title?id=1' \
--header 'X: {apikey}' \
--data ''

Response

{
    "title": "Contact"
}
GET /connect/api/v1/titles

Get Form Titles

This endpoint allows you to retrieve all form titles associated with account.

Response

  • Name
    id
    Type
    string
    Description

    The id of the form.

  • Name
    title
    Type
    string
    Description

    The title of the form.

Request

GET
/connect/api/v1/titles
curl --location 'https://likeableforms.com/connect/api/v1/titles' \
--header 'X: {apikey}' \
--data ''

Response

[
   {
      "id": "1",
      "title": "Contact",
   }
]
PUT /connect/api/v1/title

Update Form Title

This endpoint allows you to update a single form title.

Required Parameters

  • Name
    id
    Type
    parameter
    Description

    Isolates individual title by form id.

Response

  • Name
    updated
    Type
    boolean
    Description

    Status of the update.

Request

PUT
/connect/api/v1/titles
curl --location 'https://likeableforms.com/connect/api/v1/titles?id=1' \
--header 'X: {apikey}' \
--data-raw '{
      "title": "Contact Us."
  }'

Response

{
    "updated": true
]
GET /connect/api/v1/description

Get Form Description

This endpoint allows you to retrieve a single form description.

Required Parameters

  • Name
    id
    Type
    parameter
    Description

    Isolates individual description by form id.

Response

  • Name
    description
    Type
    string
    Description

    The description for the form.

Request

GET
/connect/api/v1/description
curl --location 'https://likeableforms.com/connect/api/v1/description?id=1' \
--header 'X: {apikey}' \
--data ''

Response

{
    "description": "Get in touch."
}
GET /connect/api/v1/descriptions

Get Form Descriptions

This endpoint allows you to retrieve all form descriptions associated with account.

Response

  • Name
    id
    Type
    string
    Description

    The id of the form.

  • Name
    description
    Type
    string
    Description

    The description of the form.

Request

GET
/connect/api/v1/descriptions
curl --location 'https://likeableforms.com/connect/api/v1/descriptions' \
--header 'X: {apikey}' \
--data ''

Response

[
   {
      "id": "1",
      "description": "Get in touch.",
   }
]
PUT /connect/api/v1/description

Update Form Description

This endpoint allows you to update a single form description.

Required Parameters

  • Name
    id
    Type
    parameter
    Description

    Isolates individual form description by form id.

Response

  • Name
    updated
    Type
    boolean
    Description

    Status of the update.

Request

PUT
/connect/api/v1/description
curl --location 'https://likeableforms.com/connect/api/v1/description?id=1' \
--header 'X: {apikey}' \
--data-raw '{
      "description": "Get in touch."
  }'

Response

{
    "updated": true
}