latestOpenAPI 3.1.02026-08-10150311431.9 KB
c1f3c6d96b31
Projects
List Projects
get/projects
Query parameters
searchstring
Search string to find projects
Search string to find projects
idsstring[]
The ID of a project to search for
The ID of a project to search for
namesstring[]
The name of the project
The name of the project
ownerstring[]
Owner of the project
Owner of the project
publicboolean
Boolean check for public/private projects
Boolean check for public/private projects
permissionsstring[]
Filter by permission on given resource
Filter by permission on given resource
sort_by'created_at' | 'updated_at' | 'name'
An enumeration.
Key to sort the list by
sort_order'ascending' | 'descending'
An enumeration.
The order to sort the list
pageinteger
Page number starting from 1
Page number starting from 1
per-pageinteger
Number of items per page
Number of items per page
Response
Retrieved
Example response
{
"resources": [
{
"name": "Project Falcon",
"description": "I always wanted to have a project called project Falcon",
"id": "50bb7fe0-8f19-499e-972e-1ebec8af2c71",
"owner": {
"id": "0ad77f99-8043-46e4-8220-7221487c3ee5",
"account_type": "user",
"name": "ladybugbot",
"display_name": "Ladybug Bot",
"description": "Beep Boop!"
},
"permissions": {
"read": true
},
"slug": "project-falcon"
}
]
}