Export responses for form – ConversionLab Docs

GET /forms/{form}/responses/export

Export responses for form. Requires the REST read token ability. The bearer token selects the Team; a supplied team_id cannot switch tenants. Additional role, entity-policy and plan requirements vary by operation.

Authentication

Use a team API key as Authorization: Bearer YOUR_API_KEY. The token ability and the user’s role must both allow this operation. See authentication.

{
  "ability": "read",
  "team": "Token-bound Team",
  "authorization": "Additional role, entity-policy and plan requirements vary by operation."
}

Parameters

Name	Location	Required	Description
`form`	path	Yes	The form ID
`format`	query	Yes	Format.
`filter[status]`	query	No	Filter[Status].

form

{
  "type": "integer",
  "minimum": 1
}

format

{
  "type": "string",
  "enum": [
    "csv",
    "xlsx"
  ]
}

filter[status]

{
  "anyOf": [
    {
      "type": "string",
      "enum": [
        "partial",
        "submitted"
      ],
      "title": "FormResponseStatus"
    },
    {
      "type": "null"
    }
  ]
}

Example request

curl --request GET 'https://api.example.test/api/forms/1/responses/export?format=csv' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json'

Examples use fictional data. Replace resource IDs and the API host with your environment’s values.

Responses

200

Successful response.

Response headers:

{
  "Transfer-Encoding": {
    "required": true,
    "schema": {
      "type": "string",
      "enum": [
        "chunked"
      ]
    }
  }
}

Content type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.

{
  "type": "string",
  "format": "binary"
}

Content type: text/csv; charset=UTF-8.

{
  "type": "string",
  "format": "binary"
}

401

Unauthenticated

Content type: application/json.

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Error overview."
    }
  },
  "required": [
    "message"
  ]
}

{
  "message": "The request could not be completed."
}

403

Authorization error

Content type: application/json.

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Error overview."
    }
  },
  "required": [
    "message"
  ]
}

{
  "message": "The request could not be completed."
}

404

Not found

Content type: application/json.

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Error overview."
    }
  },
  "required": [
    "message"
  ]
}

{
  "message": "The request could not be completed."
}

422

Validation error

Content type: application/json.

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Errors overview."
    },
    "errors": {
      "type": "object",
      "description": "A detailed description of each field that failed validation.",
      "additionalProperties": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    }
  },
  "required": [
    "message",
    "errors"
  ]
}

{
  "message": "The request could not be completed.",
  "errors": {
    "name": [
      "The name field is required."
    ]
  }
}

429

Rate limit exceeded. Honor Retry-After before retrying.

Response headers:

{
  "Retry-After": {
    "description": "Seconds before retrying.",
    "schema": {
      "type": "integer"
    }
  }
}

Content type: application/json.

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "example": "Too Many Attempts."
    }
  },
  "required": [
    "message"
  ]
}

{
  "message": "Too Many Attempts."
}

See API conventions for error handling, rate limits, pagination, and uploads.

On this page