Skip to main content
GET
/
apps
List all developer application that exist in the portal
curl --request GET \
  --url http://localhost:3001/portal-api/apps \
  --header 'Authorization: <api-key>'
[
  {
    "Name": "Payment App",
    "Description": "This is my payment application",
    "RedirectURLs": "https://app-host/auth",
    "UserID": 1,
    "Visibility": "personal",
    "ID": 1,
    "CreatedAt": "2023-06-25 13:37"
  }
]

Authorizations

Authorization
string
header
required

Query Parameters

limit
integer

Maximum number of records to return for this request. Overrides the row count only, not the page offset (which is always based on per_page), so use per_page for pagination rather than combining limit with page. Defaults to the per_page value.

per_page
integer
default:20

Items per page. Defaults to the resource-specific page count if configured, otherwise 20

page
integer
default:1

Page number. Defaults to 1 when omitted

Response

200 - application/json

OK

Name
string

Name of this application

Example:

"Payment App"

Description
string

Human-readable description of this application

Example:

"This is my payment application"

RedirectURLs
string

Redirect URL for OAuth2.0 authorization_code and PKCE grant types

Example:

"https://app-host/auth"

UserID
integer

UID of a user to whom this application will belong

Example:

1

Visibility
enum<string>
default:organisation

Controls who can access this application. Options are: personal (visible only to you), team (shared with your team), and organisation (accessible to all members of your organisation).

Available options:
personal,
team,
organisation
Example:

"personal"

ID
integer

UID of this app

Example:

1

CreatedAt
string

Timestamp of when this application was created

Pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}$
Example:

"2023-06-25 13:37"