List all Apps
GET /v3/apps
Fields
Name |
Description |
Default |
Valid Values |
Example Values |
Parameters
Name |
Description |
Valid Values |
Example Values |
names
|
Names of apps to filter by
|
|
- names[]=name1&names[]=name2
|
space_guids
|
Spaces to filter by
|
|
- space_guids[]=space_guid1&space_guids[]=space_guid2
|
organization_guids
|
Organizations to filter by
|
|
- organization_guids[]=org_guid1&organization_guids[]=org_guid2
|
guids
|
App guids to filter by
|
|
- guid[]=guid1&guid[]=guid2
|
page
|
Page to display
|
|
|
per_page
|
Number of results per page
|
|
|
sort
|
Value to sort by
|
- created_at, updated_at, id
|
|
direction
|
Direction to sort by
|
|
|
Request
Headers
Route
GET /v3/apps?page=1&per_page=2&sort=created_at&direction=desc
Query Parameters
page: 1
per_page: 2
sort: created_at
direction: desc
cURL
curl "https://api.[your-domain.com]/v3/apps?page=1&per_page=2&sort=created_at&direction=desc" -X GET \
-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTY3IiwiZW1haWwiOiJlbWFpbC0zOEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIucmVhZCIsImNsb3VkX2NvbnRyb2xsZXIud3JpdGUiXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI0MzEwMTIxfQ.hxaZJdvpKOFTCEL9XCSezcX4pk5Xqn74Ody26uQWicU" \
-H "Host: example.org" \
-H "Cookie: "
Response
Headers
Status
200 OK
Body
{
"pagination": {
"total_results": 3,
"first": {
"href": "/v3/apps?page=1&per_page=2"
},
"last": {
"href": "/v3/apps?page=2&per_page=2"
},
"next": {
"href": "/v3/apps?page=2&per_page=2"
},
"previous": null
},
"resources": [
{
"guid": "guid-85b4edb5-a3ad-47af-a365-790f1347e5ad",
"name": "my_app3",
"_links": {
"self": {
"href": "/v3/apps/guid-85b4edb5-a3ad-47af-a365-790f1347e5ad"
},
"processes": {
"href": "/v3/apps/guid-85b4edb5-a3ad-47af-a365-790f1347e5ad/processes"
},
"packages": {
"href": "/v3/apps/guid-85b4edb5-a3ad-47af-a365-790f1347e5ad/packages"
},
"space": {
"href": "/v2/spaces/b7031e3a-2017-4f1a-ba4a-81a66dd0f299"
}
}
},
{
"guid": "guid-e3cb4c12-1f6b-4699-8e7f-69faa2a0c20a",
"name": "my_app2",
"_links": {
"self": {
"href": "/v3/apps/guid-e3cb4c12-1f6b-4699-8e7f-69faa2a0c20a"
},
"processes": {
"href": "/v3/apps/guid-e3cb4c12-1f6b-4699-8e7f-69faa2a0c20a/processes"
},
"packages": {
"href": "/v3/apps/guid-e3cb4c12-1f6b-4699-8e7f-69faa2a0c20a/packages"
},
"space": {
"href": "/v2/spaces/b7031e3a-2017-4f1a-ba4a-81a66dd0f299"
}
}
}
]
}