Pinal Developers

API reference

Developer

Manage your apps programmatically. The same API the Developers dashboard uses.

Base URL https://accounts.pinal.tech

Scope catalog

GET /api/scopes

Every scope a third-party app can request, grouped by service, with the wording the consent screen uses.

No token needed

Responses

curl "https://accounts.pinal.tech/api/scopes"
Response · 200
{
  "groups": [
    {
      "id": "string",
      "name": "string",
      "icon": "string",
      "blurb": "string",
      "scopes": [
        {
          "id": "mail.read",
          "title": "string",
          "consent": "string",
          "description": "string",
          "level": "basic"
        }
      ]
    }
  ]
}

Public app listing

GET /api/apps/{client_id}

What the consent screen shows about an app: name, icon, description, links and developer.

No token needed

Path parameters

  • client_id string required

    The app's client ID.

Responses

curl "https://accounts.pinal.tech/api/apps/{client_id}"
Response · 200
{
  "client_id": "string",
  "name": "string",
  "description": "string",
  "icon": "string",
  "homepage": "string",
  "privacy_policy": "string",
  "terms_of_service": "string",
  "first_party": true,
  "developer": {
    "name": "string"
  },
  "users": 0
}

List your apps

GET /api/developer/apps

Apps you own, newest first. Requires a token from the Developers portal (the developer scope is not available to third-party apps).

developer

Responses

curl "https://accounts.pinal.tech/api/developer/apps" \
  -H "Authorization: Bearer $ACCESS_TOKEN"
Response · 200
{
  "apps": [
    {
      "client_id": "pnl_7Hq2xV9kLmA1",
      "name": "string",
      "description": "string",
      "icon": "string",
      "accent": "string",
      "homepage": "string",
      "privacy_policy": "string",
      "terms_of_service": "string",
      "support_email": "string",
      "type": "web",
      "public": true,
      "redirect_uris": [
        "string"
      ],
      "post_logout_redirect_uris": [
        "string"
      ],
      "scopes": [
        "string"
      ],
      "disabled": true,
      "secret_hint": "string",
      "users": 0,
      "created_at": "2026-11-19T15:20:04Z",
      "updated_at": "2026-11-19T15:20:04Z"
    }
  ]
}

Create an app

POST /api/developer/apps

Registers a new OAuth 2 client. Web apps get a client secret, returned once in this response; single-page and native apps are public clients that use PKCE.

developer

Request body application/json

  • name string
  • description string
  • icon string | null

    https URL or a data: URL (PNG, JPEG, WebP or GIF, under 256 KB).

  • accent string | null
  • homepage string | null (uri)
  • privacy_policy string | null (uri)
  • terms_of_service string | null (uri)
  • support_email string | null (email)
  • type string

    Create only. web = confidential client with a secret; spa and native = public clients with PKCE.

    One of web spa native

  • redirect_uris array of string
  • post_logout_redirect_uris array of string
  • scopes array of string

Responses

curl -X POST "https://accounts.pinal.tech/api/developer/apps" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Trailhead",
    "description": "Plan hikes with friends.",
    "type": "web",
    "homepage": "https://trailhead.example",
    "redirect_uris": [
      "https://trailhead.example/auth/callback"
    ],
    "scopes": [
      "openid",
      "profile",
      "calendar.write",
      "photos.read"
    ]
  }'
Response · 201
{
  "app": {
    "client_id": "pnl_7Hq2xV9kLmA1",
    "name": "string",
    "description": "string",
    "icon": "string",
    "accent": "string",
    "homepage": "string",
    "privacy_policy": "string",
    "terms_of_service": "string",
    "support_email": "string",
    "type": "web",
    "public": true,
    "redirect_uris": [
      "string"
    ],
    "post_logout_redirect_uris": [
      "string"
    ],
    "scopes": [
      "string"
    ],
    "disabled": true,
    "secret_hint": "string",
    "users": 0,
    "created_at": "2026-11-19T15:20:04Z",
    "updated_at": "2026-11-19T15:20:04Z"
  },
  "client_secret": "string"
}

Get an app

GET /api/developer/apps/{client_id}

One of your apps.

developer

Path parameters

  • client_id string required

    Client ID.

Responses

curl "https://accounts.pinal.tech/api/developer/apps/{client_id}" \
  -H "Authorization: Bearer $ACCESS_TOKEN"
Response · 200
{
  "app": {
    "client_id": "pnl_7Hq2xV9kLmA1",
    "name": "string",
    "description": "string",
    "icon": "string",
    "accent": "string",
    "homepage": "string",
    "privacy_policy": "string",
    "terms_of_service": "string",
    "support_email": "string",
    "type": "web",
    "public": true,
    "redirect_uris": [
      "string"
    ],
    "post_logout_redirect_uris": [
      "string"
    ],
    "scopes": [
      "string"
    ],
    "disabled": true,
    "secret_hint": "string",
    "users": 0,
    "created_at": "2026-11-19T15:20:04Z",
    "updated_at": "2026-11-19T15:20:04Z"
  }
}

Update an app

PATCH /api/developer/apps/{client_id}

Change any field except type. Send only what changes. disabled: true pauses sign-ins.

developer

Path parameters

  • client_id string required

    Client ID.

Request body application/json

  • name string
  • description string
  • icon string | null

    https URL or a data: URL (PNG, JPEG, WebP or GIF, under 256 KB).

  • accent string | null
  • homepage string | null (uri)
  • privacy_policy string | null (uri)
  • terms_of_service string | null (uri)
  • support_email string | null (email)
  • type string

    Create only. web = confidential client with a secret; spa and native = public clients with PKCE.

    One of web spa native

  • redirect_uris array of string
  • post_logout_redirect_uris array of string
  • scopes array of string
  • disabled boolean

Responses

curl -X PATCH "https://accounts.pinal.tech/api/developer/apps/{client_id}" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Now with shared albums.",
    "scopes": [
      "openid",
      "profile",
      "photos.read",
      "photos.share"
    ]
  }'
Response · 200
{
  "app": {
    "client_id": "pnl_7Hq2xV9kLmA1",
    "name": "string",
    "description": "string",
    "icon": "string",
    "accent": "string",
    "homepage": "string",
    "privacy_policy": "string",
    "terms_of_service": "string",
    "support_email": "string",
    "type": "web",
    "public": true,
    "redirect_uris": [
      "string"
    ],
    "post_logout_redirect_uris": [
      "string"
    ],
    "scopes": [
      "string"
    ],
    "disabled": true,
    "secret_hint": "string",
    "users": 0,
    "created_at": "2026-11-19T15:20:04Z",
    "updated_at": "2026-11-19T15:20:04Z"
  }
}

Delete an app

DELETE /api/developer/apps/{client_id}

Deletes the app, revokes every token and removes it from people's connected apps.

developer

Path parameters

  • client_id string required

    Client ID.

Responses

curl -X DELETE "https://accounts.pinal.tech/api/developer/apps/{client_id}" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Rotate the secret

POST /api/developer/apps/{client_id}/secret

Issues a new client secret and invalidates the old one immediately. The new secret is returned once.

developer

Path parameters

  • client_id string required

    Client ID.

Responses

curl -X POST "https://accounts.pinal.tech/api/developer/apps/{client_id}/secret" \
  -H "Authorization: Bearer $ACCESS_TOKEN"
Response · 200
{
  "app": {
    "client_id": "pnl_7Hq2xV9kLmA1",
    "name": "string",
    "description": "string",
    "icon": "string",
    "accent": "string",
    "homepage": "string",
    "privacy_policy": "string",
    "terms_of_service": "string",
    "support_email": "string",
    "type": "web",
    "public": true,
    "redirect_uris": [
      "string"
    ],
    "post_logout_redirect_uris": [
      "string"
    ],
    "scopes": [
      "string"
    ],
    "disabled": true,
    "secret_hint": "string",
    "users": 0,
    "created_at": "2026-11-19T15:20:04Z",
    "updated_at": "2026-11-19T15:20:04Z"
  },
  "client_secret": "string"
}