Sign in
latestOpenAPI 3.1.02026-08-10150311431.9 KB

c1f3c6d96b31

Applications

List Applications

get/applications

Query parameters

searchstring

Search string to find applications

Search string to find applications

idsstring[]

The ID of a application to search for

The ID of a application to search for

namesstring[]

The name of the application

The name of the application

ownerstring[]

Owner of the application

Owner of the application

publicboolean

Boolean check for public/private applications

Boolean check for public/private applications

deployedboolean

Filter by deployed applications

Filter by deployed applications

permissionsstring[]

Filter by permission on given resource

Filter by permission on given resource

keywordsstring[]

Filter by keywords on given resource

Filter by keywords 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

pageinteger required

The current page the pagination request is on

per_pageinteger required

The number of pages per pagination request

next_pageinteger

The next page, if this on is not the last

page_countinteger required

The total number of pages

total_countinteger required

The total number of resources matching the list request

Example response

{
  "resources": [
    {
      "name": "Application Falcon",
      "description": "I always wanted to have a application called application Falcon",
      "keywords": [
        "falcon",
        "api"
      ],
      "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": "application-falcon"
    }
  ]
}