Form Responses

List Form Responses

Retrieve a paginated list of form responses for the blog. You can filter by form ID, and each response includes relationship identifiers for the related form, post, and blog when available.

get/form-responses

Request

Query parameters

pageinteger
Example:1

Page number (starting from 1) JSON:API style page[number] is also accepted.

limitinteger
Example:10

Items per page JSON:API style page[size] is also accepted.

form_idinteger
Example:123

Filter responses by form ID

Response

Form responses retrieved successfully

Example response

{
  "jsonapi": {
    "version": "1.0"
  },
  "data": [
    {
      "type": "form_responses",
      "id": "123",
      "attributes": {
        "email": "user@example.com",
        "response": {
          "Name": "John Doe",
          "Message": "Hello!"
        },
        "country": "United States",
        "city": "New York",
        "region": "New York",
        "timezone": "America/New_York",
        "language": "en-US",
        "created_at": "2024-01-15T09:30:00Z"
      },
      "relationships": {
        "forms": {
          "data": {
            "type": "tags",
            "id": "123"
          }
        },
        "posts": {
          "data": {
            "type": "tags",
            "id": "123"
          }
        },
        "blogs": {
          "data": {
            "type": "tags",
            "id": "123"
          }
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 4 revisions of this API.