Form

Estimated reading: 4 minutes 24 views

GET /v1/forms/

				
					https://rest.gohighlevel.com/v1/forms/

Get Forms.

Authorization:

Provide your location api key (Bearer Token). You can find here

AUTHORIZATION Bearer Token

Token

<token>

EXAMPLE REQUEST (curl)

				
					curl --location 'https://rest.gohighlevel.com/v1/forms/' \
--header 'Authorization: Bearer <token>'

EXAMPLE RESPONSE (json)

				
					{
  "forms": [
    {
      "id": "uP9CBUzKKZkP5BtkHeK3",
      "name": "Form 1"
    },
    {
      "id": "uP9CBUzKKZkP5BtkHeK3",
      "name": "Form 1"
    }
  ]
}

GET /v1/forms/submissions

				
					https://rest.gohighlevel.com/v1/forms/submissions?page=1&limit=20&formId=jjusM6EOngDExnbo2DbU&q=john@deo.com&startAt=2020-11-14&endAt=2020-12-14

Get form submissions.

Authorization:

Provide your location api key (Bearer Token). You can find here

AUTHORIZATION Bearer Token

Token

<token>

PARAMS

page

Page No. By default it will be 1

limit

Limit Per Page records count. will allow maximum up to 100 and default will be 20

formId

jjusM6EOngDExnbo2DbU

Filter submission by form id

q

john@deo.com

Filter by contactId, name, email or phone no.

startAt

2020-11-14

Get submission by starting of this date. By default it will be same date of last month.

endAt

2020-12-14

Get submission by ending of this date. By default it will be current date.

EXAMPLE REQUEST (curl)

				
					curl --location 'https://rest.gohighlevel.com/v1/forms/submissions?page=1&limit=20&formId=jjusM6EOngDExnbo2DbU&q=john%40deo.com&startAt=2020-11-14&endAt=2020-12-14' \
--header 'Authorization: Bearer <token>'

EXAMPLE RESPONSE (json)

				
					{
  "submissions": [
    {
      "id": "be759b9a-c3ec-4b29-ba07-fc3c89c77673",
      "contactId": "9NkT25Vor1v4aQatFsv2",
      "__submissions_other_field__": "john@deo.com",
      "__custom_field_id__": "20",
      "createdAt": "2020-11-01T18:02:21.000Z",
      "formId": "jjusM6EOngDExnbo2DbU",
      "pageDetails": {
        "url": "https://www.gohighlevel.com/",
        "source": "Social Media",
        "referrer": "http://m.facebook.com",
        "fbclid": "IwAR1JoTTltt3EKJE3O-MrQij_lTeA6BKGTy8M2wKepSzs4oUbTYhL2Lns18w"
      }
    },
    {
      "id": "be759b9a-c3ec-4b29-ba07-fc3c89c77673",
      "contactId": "9NkT25Vor1v4aQatFsv2",
      "__submissions_other_field__": "john@deo.com",
      "__custom_field_id__": "20",
      "createdAt": "2020-11-01T18:02:21.000Z",
      "formId": "jjusM6EOngDExnbo2DbU",
      "pageDetails": {
        "url": "https://www.gohighlevel.com/",
        "source": "Social Media",
        "referrer": "http://m.facebook.com",
        "fbclid": "IwAR1JoTTltt3EKJE3O-MrQij_lTeA6BKGTy8M2wKepSzs4oUbTYhL2Lns18w"
      }
    }
  ],
  "meta": {
    "total": 250,
    "currentPage": 2,
    "nextPage": 3,
    "prevPage": 1
  }
}

Docly

Did You Know?

Form

GET /v1/forms/

Get Forms.

AUTHORIZATION Bearer Token

Token

EXAMPLE REQUEST (curl)

EXAMPLE RESPONSE (json)

GET /v1/forms/submissions

Get form submissions.

AUTHORIZATION Bearer Token

Token

PARAMS

page

limit

formId

q

startAt

endAt

EXAMPLE REQUEST (curl)

EXAMPLE RESPONSE (json)

Leave a Comment Cancel reply

CONTENTS