Log inTry for free
Back to all APIs

Get forms

Use this method to get a list of forms.

Please log in to see full path URL. Learn why.
get
/forms/1/forms
Authorizations:
API Key Header
Basic
IBSSO Token Header
OAuth 2
Scopes:
forms:manage
forms:read
web:sdk
query Parameters
offset
integer <int32>
Default: 0
Example: offset=60

Skip first {offset} forms of the list.

limit
integer <int32>
Default: 25
Example: limit=30

The maximum number of returned forms. Maximum value is 100.

formType
string
Enum: "OPT_IN" "OPT_OUT" "FACEBOOK" "LIVECHAT" "APPLE"
Example: formType=APPLE

The type of returned forms.

formStatus
string
Enum: "ACTIVE" "DISABLED" "DRAFT"
Example: formStatus=ACTIVE

The status of returned forms.

Responses

200

Successful Response

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Request samples

Example
cURL
Copy
curl -L -g 'https://{baseUrl}/forms/1/forms?offset=60&limit=30&formType=APPLE&formStatus=ACTIVE' \
-H 'Authorization: {authorization}' \
-H 'Accept: application/json'

Response samples

Content type
application/json
Copy
 Collapse all
{
  • "forms":
    [
    • {
      • "id": "f23f0f7c-9898-4feb-8f21-5afe2c29db7e",
      • "name": "Test form",
      • "elements":
        [
        • {
          • "component": "TEXT",
          • "fieldId": "first_name",
          • "personField": "firstName",
          • "label": "First Name",
          • "isRequired": false,
          • "isHidden": false,
          • "additionalConfiguration": { },
          • "validationRules":
            {
            • "maxLength": 255,
            • "sample": "James",
            • "forbiddenSymbols":
              [
              • "^",
              • "&",
              • "<",
              • ">",
              • "\"",
              • "/",
              • "\\",
              • "\n",
              • "\r",
              • ":",
              • "(",
              • ")",
              • "{",
              • "}",
              • "=",
              • ";",
              • "#",
              • "|",
              • "+",
              • "%",
              • "*",
              • "?",
              • "[",
              • "]"
              ]
            },
          • "placeholder": "First Name"
          },
        • {
          • "component": "TEXT",
          • "fieldId": "last_name",
          • "personField": "lastName",
          • "label": "Last Name",
          • "isRequired": false,
          • "isHidden": false,
          • "additionalConfiguration": { },
          • "validationRules":
            {
            • "maxLength": 255,
            • "sample": "James",
            • "forbiddenSymbols":
              [
              • "^",
              • "&",
              • "<",
              • ">",
              • "\"",
              • "/",
              • "\\",
              • "\n",
              • "\r",
              • ":",
              • "(",
              • ")",
              • "{",
              • "}",
              • "=",
              • ";",
              • "#",
              • "|",
              • "+",
              • "%",
              • "*",
              • "?",
              • "[",
              • "]"
              ]
            },
          • "placeholder": "Last Name"
          },
        • {
          • "component": "TEXT",
          • "fieldId": "company",
          • "personField": "267ce64a-1a26-4326-9036-6384696f39c8",
          • "label": "Company",
          • "isRequired": false,
          • "isHidden": false,
          • "additionalConfiguration": { },
          • "validationRules":
            {
            • "maxLength": 1000,
            • "sample": "Lorem ipsum"
            },
          • "placeholder": "Company"
          },
        • {
          • "component": "TEXT",
          • "fieldId": "country",
          • "personField": "country",
          • "label": "Country",
          • "isRequired": false,
          • "isHidden": false,
          • "additionalConfiguration": { },
          • "validationRules":
            {
            • "maxLength": 1000,
            • "sample": "Lorem ipsum"
            },
          • "placeholder": "Country"
          },
        • {
          • "component": "EMAIL",
          • "fieldId": "email",
          • "personField": "email",
          • "label": "Email Address",
          • "isRequired": true,
          • "isHidden": false,
          • "additionalConfiguration": { },
          • "validationRules":
            {
            • "maxLength": 1000,
            • "pattern": "(?:[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*|\"(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21\\x23-\\x5b\\x5d-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])*\")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21-\\x5a\\x53-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])+)\\])",
            • "sample": "email@example.com"
            },
          • "placeholder": "Email"
          },
        • {
          • "component": "TEXTAREA",
          • "fieldId": "business_needs",
          • "label": "Business Needs",
          • "isRequired": false,
          • "isHidden": false,
          • "additionalConfiguration": { },
          • "validationRules":
            {
            • "maxLength": 3000,
            • "sample": "Lorem ipsum ..."
            },
          • "placeholder": ""
          },
        • {
          • "component": "TEXT",
          • "fieldId": "offer_id",
          • "label": "OfferId",
          • "isRequired": false,
          • "isHidden": false,
          • "additionalConfiguration": { },
          • "validationRules":
            {
            • "maxLength": 1000,
            • "sample": "Lorem ipsum"
            },
          • "placeholder": "OfferId"
          },
        • {
          • "component": "TEXT",
          • "fieldId": "plan_id",
          • "label": "PlanId",
          • "isRequired": false,
          • "isHidden": false,
          • "additionalConfiguration": { },
          • "validationRules":
            {
            • "maxLength": 1000,
            • "sample": "Lorem ipsum"
            },
          • "placeholder": "PlanId"
          },
        • {
          • "component": "TEXT",
          • "fieldId": "subscription_id",
          • "label": "SubscriptionId",
          • "isRequired": false,
          • "isHidden": false,
          • "additionalConfiguration": { },
          • "validationRules":
            {
            • "maxLength": 1000,
            • "sample": "Lorem ipsum"
            },
          • "placeholder": "SubscriptionId"
          },
        • {
          • "component": "TEXT",
          • "fieldId": "Tenant_id",
          • "label": "TenantId",
          • "isRequired": false,
          • "isHidden": false,
          • "additionalConfiguration": { },
          • "validationRules":
            {
            • "maxLength": 1000,
            • "sample": "Lorem ipsum"
            },
          • "placeholder": "TenantId"
          },
        • {
          • "component": "SUBMIT_BUTTON",
          • "label": "Submit"
          }
        ],
      • "createdAt": "2022-07-11T06:38:12.757+0000",
      • "updatedAt": "2022-07-11T06:45:12.826+0000",
      • "resubmitEnabled": true,
      • "formType": "OPT_IN",
      • "formStatus": "ACTIVE"
      },
    • {
      • "id": "7370b24c-9788-4a52-a6a4-047cecbe2df2",
      • "name": "test",
      • "elements":
        [
        • {
          • "component": "EMAIL",
          • "fieldId": "email",
          • "personField": "email",
          • "label": "Email",
          • "isRequired": false,
          • "isHidden": false,
          • "additionalConfiguration": { },
          • "validationRules":
            {
            • "maxLength": 1000,
            • "pattern": "(?:[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*|\"(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21\\x23-\\x5b\\x5d-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])*\")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21-\\x5a\\x53-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])+)\\])",
            • "sample": "email@example.com"
            },
          • "placeholder": "Email"
          },
        • {
          • "component": "SUBMIT_BUTTON",
          • "label": "Submit"
          }
        ],
      • "createdAt": "2022-06-15T13:21:38.195+0000",
      • "updatedAt": "2022-06-15T13:21:46.286+0000",
      • "resubmitEnabled": true,
      • "formType": "OPT_IN",
      • "formStatus": "ACTIVE"
      }
    ],
  • "offset": 0,
  • "limit": 25,
  • "total": 2
}

Need assistance

Explore Infobip Tutorials

Encountering issues

Contact our support

What's new? Check out

Release Notes

Unsure about a term? See

Glossary

Research panel

Help shape the future of our products
Learn more
Service status

Copyright @ 2006-2025 Infobip ltd.

Privacy documentsTerms of use