Skip to content
Documentation

List Projects

GET
/api/v1/workspaces/{workspace_id}/projects

Retrieves the projects the user has access to.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
workspace_id
required
integer

Workspace ID

Query Parameters

Section titled “Query Parameters ”
per
integer
default: 10

Number of records per page

page
integer
default: 1

Page number

team_id
integer

Filter projects by team ID

search
string

Filter projects by name

sort
string
Allowed values: created_at_asc created_at_desc updated_at_asc updated_at_desc name_asc name_desc

Sorting

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful

object
results
required
Array<object>
object
id
required
integer
Example
12345
name
required
string
Example
Black Friday 2023
created_at
required
string format: date-time
Example
2023-08-23T10:30:00.000Z
updated_at
string format: date-time
Example
2023-08-23T10:30:00.000Z
description
string
Example
Black Friday 2023 Marketing Campaign
organization_id
required
integer
Example
12345
team_id
required
integer
Example
12345
team
required
object
id
required
integer
Example
12345
name
required
string
Example
Liverpool FC
badge_color
required
string
Allowed values: white black gray red green blue yellow purple pink orange brown cyan lime teal indigo
workspace_id
required
integer
Example
12345
created_at
required
string format: date-time
Example
2023-08-23T10:30:00.000Z
pagination
required
object
per
required
integer
Example
10
page
required
integer
Example
1
total
required
integer
Example
100