Applications ¶
applications¶
POST /api/v1/applications¶
Create Application
Description
Create a private application for devevelopment purposes.
This endpoint creates private applications suitable for development and testing. Private apps cannot be published to the marketplace. To create a public application, use the web interface where additional metadata (description, image, privacy policy) can be provided.
When a page slug is provided, the page URL is automatically added to the redirect URIs. If no explicit redirect URIs are provided, localhost is also added to allow local development.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBearer |
header | string | N/A | No | JWT Bearer token |
refreshed-token |
header | No | |||
token |
cookie | string | No |
Request body
{
"name": "string",
"description": null,
"redirect_uris": null,
"page": null,
"generate_secret": true
}
Schema of the request body
{
"properties": {
"name": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "null"
}
],
"title": "Description"
},
"redirect_uris": {
"anyOf": [
{
"items": {
"type": "string",
"minLength": 1,
"format": "uri"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Redirect Uris"
},
"page": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Page"
},
"generate_secret": {
"type": "boolean",
"title": "Generate Secret",
"default": false
}
},
"type": "object",
"required": [
"name"
],
"title": "ApplicationCreate",
"description": "Create a private application.\n\nThis endpoint creates private applications suitable for development and testing.\nPrivate apps cannot be published to the marketplace. To create a public application,\nuse the web interface where additional metadata (description, image, privacy policy)\ncan be provided."
}
Responses
{
"id": "string",
"name": "string",
"description": null,
"image": null,
"url": null,
"redirect_uris": null,
"privacy_statement": null,
"published": true,
"webhook_endpoints": null,
"webhook_secret": null,
"client_secret": null,
"page": null,
"is_private": true,
"is_clientside_app": true
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"image": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"format": "uri"
},
{
"type": "null"
}
],
"title": "Image"
},
"url": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"format": "uri"
},
{
"type": "null"
}
],
"title": "Url"
},
"redirect_uris": {
"anyOf": [
{
"items": {
"type": "string",
"minLength": 1,
"format": "uri"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Redirect Uris"
},
"privacy_statement": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"format": "uri"
},
{
"type": "null"
}
],
"title": "Privacy Statement"
},
"published": {
"type": "boolean",
"title": "Published"
},
"webhook_endpoints": {
"anyOf": [
{
"items": {
"type": "string",
"minLength": 1,
"format": "uri"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Webhook Endpoints"
},
"webhook_secret": {
"anyOf": [
{
"type": "string",
"format": "password",
"writeOnly": true
},
{
"type": "null"
}
],
"title": "Webhook Secret"
},
"client_secret": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Client Secret"
},
"page": {
"anyOf": [
{
"$ref": "#/components/schemas/PageResponse"
},
{
"type": "null"
}
]
},
"is_private": {
"type": "boolean",
"title": "Is Private",
"description": "An application is private if it is missing any of: description, URL, image, or privacy statement.",
"readOnly": true
},
"is_clientside_app": {
"type": "boolean",
"title": "Is Clientside App",
"description": "Check if this is a client-side app based on privacy policy URL.\n\nApps published via fast-track have privacy_statement set to the standard\nclient-side privacy policy URL, indicating they attested to being client-side.",
"readOnly": true
}
},
"type": "object",
"required": [
"id",
"name",
"published",
"is_private",
"is_clientside_app"
],
"title": "ApplicationCreateResponse",
"description": "Response for created application."
}
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /api/v1/applications¶
List Applications
Description
List all applications owned by the authenticated user.
Returns a list of applications with minimal information (id, name, page_slug). Applications are sorted by creation date descending (newest first).
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBearer |
header | string | N/A | No | JWT Bearer token |
refreshed-token |
header | No | |||
token |
cookie | string | No |
Responses
[
{
"id": "string",
"name": "string",
"page_slug": null
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplicationListItem"
},
"title": "Response List Applications Api V1 Applications Get"
}
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
Schemas¶
ApplicationCreate¶
| Name | Type | Description |
|---|---|---|
description |
||
generate_secret |
boolean | |
name |
string | |
page |
||
redirect_uris |
ApplicationCreateResponse¶
| Name | Type | Description |
|---|---|---|
client_secret |
||
description |
||
id |
string | |
image |
||
is_clientside_app |
boolean | Check if this is a client-side app based on privacy policy URL. Apps published via fast-track have privacy_statement set to the standard client-side privacy policy URL, indicating they attested to being client-side. |
is_private |
boolean | An application is private if it is missing any of: description, URL, image, or privacy statement. |
name |
string | |
page |
||
privacy_statement |
||
published |
boolean | |
redirect_uris |
||
url |
||
webhook_endpoints |
||
webhook_secret |
ApplicationListItem¶
| Name | Type | Description |
|---|---|---|
id |
string | |
name |
string | |
page_slug |
HTTPValidationError¶
| Name | Type | Description |
|---|---|---|
detail |
Array<ValidationError> |
PageApplicationInfo¶
| Name | Type | Description |
|---|---|---|
id |
string | |
is_private |
boolean | |
name |
string |
PageResponse¶
| Name | Type | Description |
|---|---|---|
application |
PageApplicationInfo | |
published |
boolean | |
slug |
string | |
url |
string | The public URL where this page is served. |
ValidationError¶
| Name | Type | Description |
|---|---|---|
loc |
Array<> | |
msg |
string | |
type |
string |
Security schemes¶
| Name | Type | Scheme | Description |
|---|---|---|---|
| HTTPBearer | http | bearer | |
| HTTPBasic | http | basic |