Skip to main content
GET
/
surveys
List surveys
curl --request GET \
  --url https://api.pickfu.com/v1/surveys \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "url": "<string>",
      "status": "<string>",
      "type": "<string>",
      "countryCode": "<string>",
      "sampleSize": 123,
      "numResponses": 123,
      "createdAt": "<string>",
      "publishedAt": "<string>",
      "completedAt": "<string>",
      "creatorName": "<string>",
      "targeting": [
        "<string>"
      ],
      "tags": [
        {
          "id": 123,
          "name": "<string>"
        }
      ],
      "projects": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "elements": [
        {
          "id": "<string>",
          "question": "<string>",
          "subtype": "<string>",
          "variant": "<string>",
          "position": 123
        }
      ]
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "totalPages": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://www.pickfu.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

OAuth2 access token obtained via the authorization flow. Include in the Authorization header as: Bearer {access_token}

Query Parameters

page
integer
default:1

Page number

Required range: x >= 1
limit
integer
default:20

Results per page (1-100)

Required range: 1 <= x <= 100
status
string

Filter by survey status. Comma-separated values: completed, in-progress, unpublished, archived

type
string

Filter by question type. Comma-separated values: head_to_head, ranked, open_ended, click_test, etc.

option_type
string

Filter by option type (e.g. text, image). Comma-separated.

countries
string

Filter by country codes. Comma-separated (e.g. US,GB,CA).

tags
string

Filter by tag IDs. Comma-separated.

audiences
string

Filter by audience IDs. Comma-separated.

text
string

Full-text search across survey names and questions

Maximum string length: 255
member_id
string

Filter by team member ID(s). Comma-separated.

project_ids
string

Filter by project GUIDs or numeric IDs. Comma-separated.

published_after
string<date-time>

Only include surveys published after this ISO 8601 datetime

sort_by
enum<string>
default:createdAt

Field to sort by

Available options:
createdAt,
name,
creator,
status
dir
enum<string>
default:desc

Sort direction

Available options:
asc,
desc

Response

200 - application/json

Default Response

data
object[]

List of surveys

pagination
object

Pagination metadata