curl --request GET \
--url https://api.example.com/api/projects \
--header 'Authorization: Bearer <token>'{
"results": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"organisationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": "v1",
"createdAt": "<string>",
"updatedAt": "<string>",
"key": "<string>",
"protected": true,
"deletedAt": "<string>",
"decisionsApprovalMode": "require_one_per_team",
"decisionsApprovalGroups": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"members": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"owner": true,
"user": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "jsmith@example.com",
"firstName": "<string>",
"lastName": "<string>"
}
}
]
}
],
"paginate": {
"current": 123,
"from": 123,
"to": 123,
"total": 123,
"pageSize": 123
}
}Retrieve a paginated list of projects the user has access to within the organisation.
curl --request GET \
--url https://api.example.com/api/projects \
--header 'Authorization: Bearer <token>'{
"results": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"organisationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": "v1",
"createdAt": "<string>",
"updatedAt": "<string>",
"key": "<string>",
"protected": true,
"deletedAt": "<string>",
"decisionsApprovalMode": "require_one_per_team",
"decisionsApprovalGroups": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"members": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"owner": true,
"user": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "jsmith@example.com",
"firstName": "<string>",
"lastName": "<string>"
}
}
]
}
],
"paginate": {
"current": 123,
"from": 123,
"to": 123,
"total": 123,
"pageSize": 123
}
}Documentation Index
Fetch the complete documentation index at: https://docs.gorules.io/llms.txt
Use this file to discover all available pages before exploring further.
Personal access token is obtained through your profile
Search term to filter projects by name
If true, list all projects in the organisation (admin/owner only)
true, false, True, False, TRUE, FALSE If true, list soft-deleted projects (admin/owner only)
true, false, True, False, TRUE, FALSE Current page
Number of items per page
Was this page helpful?