> ## Documentation Index
> Fetch the complete documentation index at: https://docs.userplane.io/llms.txt
> Use this file to discover all available pages before exploring further.
# List Projects
> Retrieve a paginated list of projects in a workspace
Returns a paginated list of projects in the specified workspace.
## Errors
| Error code | Status | Description |
| ----------- | ------ | ------------------------ |
| `FORBIDDEN` | 403 | Insufficient permissions |
Also returns [common authentication errors](/api/error-handling#authentication-errors).
## Related
Retrieve details for a specific project
Filter recording links by project
Filter recordings by project
Page-based pagination for list endpoints
## OpenAPI
````yaml GET /public/workspace/{workspaceId}/projects
openapi: 3.1.1
info:
title: Userplane Public API
version: 1.0.0
description: >-
Programmatic access to Userplane workspaces, recordings, and links.
Authenticate with a Bearer token using your API key (uspl_ prefix).
servers:
- url: https://api.userplane.io/api/v1
description: Production
security:
- bearerAuth: []
paths:
/public/workspace/{workspaceId}/projects:
get:
tags:
- Projects
summary: List projects
description: Retrieve paginated list of projects
operationId: projects.list
parameters:
- name: workspaceId
in: path
required: true
schema:
type: string
minLength: 1
- name: page
in: query
required: true
schema:
default: 1
type: integer
exclusiveMinimum: 0
maximum: 9007199254740991
allowEmptyValue: true
allowReserved: true
- name: per_page
in: query
required: true
schema:
default: 5
type: integer
minimum: 1
maximum: 10
allowEmptyValue: true
allowReserved: true
- name: sort_by
in: query
required: true
schema:
default: created_at
type: string
enum:
- created_at
- project_title
allowEmptyValue: true
allowReserved: true
- name: sort_direction
in: query
required: true
schema:
default: desc
type: string
enum:
- asc
- desc
allowEmptyValue: true
allowReserved: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
message:
type: string
data:
type: object
properties:
workspaceId:
type: string
minLength: 1
projects:
type: array
items:
type: object
properties:
projectId:
type: string
minLength: 1
projectTitle:
type: string
isDefault:
type: boolean
recordingRetentionDays:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
createdAt: {}
updatedAt: {}
required:
- projectId
- projectTitle
- isDefault
- recordingRetentionDays
- createdAt
- updatedAt
additionalProperties: false
pagination:
type: object
properties:
page:
type: integer
exclusiveMinimum: 0
maximum: 9007199254740991
perPage:
type: integer
exclusiveMinimum: 0
maximum: 9007199254740991
total:
type: integer
minimum: 0
maximum: 9007199254740991
totalPages:
type: integer
minimum: 0
maximum: 9007199254740991
hasMore:
type: boolean
required:
- page
- perPage
- total
- totalPages
- hasMore
additionalProperties: false
required:
- workspaceId
- projects
- pagination
additionalProperties: false
required:
- message
- data
additionalProperties: false
'400':
description: '400'
content:
application/json:
schema:
oneOf:
- type: object
properties:
defined:
const: true
code:
const: BAD_REQUEST
status:
const: 400
message:
type: string
default: >-
Invalid request parameters. Check the request body and
query parameters. See
https://docs.userplane.io/api/error-handling
data: {}
required:
- defined
- code
- status
- message
- type: object
properties:
defined:
const: false
code:
type: string
status:
type: number
message:
type: string
data: {}
required:
- defined
- code
- status
- message
'401':
description: '401'
content:
application/json:
schema:
oneOf:
- type: object
properties:
defined:
const: true
code:
const: API_KEY_REQUIRED
status:
const: 401
message:
type: string
default: >-
API key is required. Include it as Authorization:
Bearer . See
https://docs.userplane.io/api/authentication
data: {}
required:
- defined
- code
- status
- message
- type: object
properties:
defined:
const: true
code:
const: API_KEY_INVALID
status:
const: 401
message:
type: string
default: >-
The provided API key is not valid. Verify the key and
try again. See
https://docs.userplane.io/api/authentication
data: {}
required:
- defined
- code
- status
- message
- type: object
properties:
defined:
const: true
code:
const: API_KEY_EXPIRED
status:
const: 401
message:
type: string
default: >-
The API key has expired. Rotate or create a new key.
See https://docs.userplane.io/api/authentication
data: {}
required:
- defined
- code
- status
- message
- type: object
properties:
defined:
const: false
code:
type: string
status:
type: number
message:
type: string
data: {}
required:
- defined
- code
- status
- message
'403':
description: '403'
content:
application/json:
schema:
oneOf:
- type: object
properties:
defined:
const: true
code:
const: API_KEY_DISABLED
status:
const: 403
message:
type: string
default: >-
The API key is disabled. Enable it or create a new
key. See https://docs.userplane.io/api/authentication
data: {}
required:
- defined
- code
- status
- message
- type: object
properties:
defined:
const: true
code:
const: NOT_A_MEMBER
status:
const: 403
message:
type: string
default: >-
The API key owner is not a member of this workspace.
See https://docs.userplane.io/api/error-handling
data: {}
required:
- defined
- code
- status
- message
- type: object
properties:
defined:
const: true
code:
const: FORBIDDEN
status:
const: 403
message:
type: string
default: Insufficient permissions
data: {}
required:
- defined
- code
- status
- message
- type: object
properties:
defined:
const: false
code:
type: string
status:
type: number
message:
type: string
data: {}
required:
- defined
- code
- status
- message
'404':
description: '404'
content:
application/json:
schema:
oneOf:
- type: object
properties:
defined:
const: true
code:
const: WORKSPACE_NOT_FOUND
status:
const: 404
message:
type: string
default: Workspace not found
data: {}
required:
- defined
- code
- status
- message
- type: object
properties:
defined:
const: false
code:
type: string
status:
type: number
message:
type: string
data: {}
required:
- defined
- code
- status
- message
'410':
description: '410'
content:
application/json:
schema:
oneOf:
- type: object
properties:
defined:
const: true
code:
const: WORKSPACE_GONE
status:
const: 410
message:
type: string
default: Workspace has been deleted
data: {}
required:
- defined
- code
- status
- message
- type: object
properties:
defined:
const: false
code:
type: string
status:
type: number
message:
type: string
data: {}
required:
- defined
- code
- status
- message
'429':
description: '429'
content:
application/json:
schema:
oneOf:
- type: object
properties:
defined:
const: true
code:
const: RATE_LIMITED
status:
const: 429
message:
type: string
default: >-
Rate limit exceeded. Wait and retry with exponential
backoff. See https://docs.userplane.io/api/rate-limits
data: {}
required:
- defined
- code
- status
- message
- type: object
properties:
defined:
const: false
code:
type: string
status:
type: number
message:
type: string
data: {}
required:
- defined
- code
- status
- message
'503':
description: '503'
content:
application/json:
schema:
oneOf:
- type: object
properties:
defined:
const: true
code:
const: SERVICE_UNAVAILABLE
status:
const: 503
message:
type: string
default: >-
API key verification service is temporarily
unavailable. Please try again later. See
https://docs.userplane.io/api/error-handling
data: {}
required:
- defined
- code
- status
- message
- type: object
properties:
defined:
const: false
code:
type: string
status:
type: number
message:
type: string
data: {}
required:
- defined
- code
- status
- message
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: >-
API key with uspl_ prefix. Create keys at
dash.userplane.io/_/account?tab=developers
````