Skip to content

Create an application

OpenAPI JSON
POST
/v1/apps
curl --request POST \
  --url https://api.eu.apigami.com/v1/apps \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "visibility": "private", "redirect_uris": [], "avatar_file_id": null }'

Creates an application in your team. It holds no code and reserves no public name: the slug comes from the manifest of a version, at its first deploy. Requires a confirmed email.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required

What a person sees when they connect to it.

string
>= 1 characters <= 200 characters
visibility

private: your team only. unlisted or public sends each publication to review first. The person’s decision.

string
default: private
Allowed values: private unlisted public
redirect_uris
Array<string>
default: <= 100 items
avatar_file_id
string | null format: uuid

Responses

Section titled “Responses”

201

Section titled “201”

The application. Its id is the app_id every other route takes.

Media typeapplication/json
object
id
required

The app_id.

string format: uuid
group_id
required
string format: uuid
name
required
string
redirect_uris
required
Array<string>
avatar_file_id
required
string | null format: uuid
visibility
required
string
Allowed values: private unlisted public
verified_at
required
string | null format: date-time
created_at
required
string format: date-time
Example
{
  "visibility": "private"
}

403

Section titled “403”

The person’s email is not confirmed yet.

Media typeapplication/json
object
error
required
string
consentPending

Present and true when the approval window is open and the user has not answered within 45 s.

boolean
Example
{
  "error": "verify your email before creating an app"
}