Skip to main content
GET
/
projects
List projects
curl --request GET \
  --url https://api.pickfu.com/v1/projects \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "projects": [
      {
        "id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "goal": "<string>",
        "archived": true,
        "bookmarked": true,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "url": "<string>",
        "user": "<string>",
        "surveys": [
          {
            "guid": "<string>",
            "question": "<string>",
            "type": "<string>",
            "state": "<string>",
            "respondentsAmount": 123
          }
        ]
      }
    ],
    "pagination": {
      "page": 123,
      "limit": 123,
      "total": 123,
      "totalPages": 123
    }
  }
}

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:25

Number of projects per page

Required range: 1 <= x <= 100
bookmarked
boolean

Filter to bookmarked projects only

archived
boolean

Filter to archived projects only

Response

200 - application/json

Default Response

success
boolean
data
object