Applications

List applications

List applications owned by the current organization, returning pagination metadata to help choose the right application before managing collections or loyalty settings.

get/v1/applications

Request

  • Base URL: https://api.prod.keyban.io
  • URL: https://api.prod.keyban.io/v1/applications
  • Auth: one of:
    • API key in header X-Api-Key
    • bearer (a scheme the document does not define)

Query parameters

field'id' | 'createdAt' | 'updatedAt' required
order'asc' | 'desc' required
currentPageinteger

1-based page index.

pageSizeinteger

Number of items per page.

Response

List of applications retrieved successfully

totalinteger required

Total count of items matching the query

Example response

{
  "data": [
    {
      "organization": {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "createdAt": "2024-01-15T09:30:00.000Z",
        "name": "Keyban SAS",
        "slug": "keyban-sas",
        "logo": "https://cdn.example.com/logos/keyban.png",
        "defaultLocale": "fr-FR",
        "preferredCurrency": "EUR",
        "agentRoles": [
          "sales",
          "analyst"
        ],
        "acquisitionChannel": "n8n",
        "settings": {
          "authConfig": {
            "auth0": {
              "clientId": "abc123xyz",
              "domain": "keyban.eu.auth0.com"
            }
          }
        }
      },
      "slug": "my-shop-app",
      "preferredCurrency": "EUR",
      "network": "BaseMainnet",
      "dppSettings": {
        "tokens": [
          {
            "address": "0x04ceB44e3b6E4aC4C14f29F7e0Ee40DAFcb3A0e1",
            "name": "DPP Certification Token",
            "symbol": "DPP"
          }
        ],
        "actions": [
          {
            "type": "circularity",
            "url": "https://example.com/authenticity-proof",
            "label": {
              "en-US": "Verify authenticity",
              "fr-FR": "Vérifier l'authenticité"
            },
            "description": {
              "en-US": "Verify authenticity",
              "fr-FR": "Vérifier l'authenticité"
            },
            "icon": "recycle"
          }
        ],
        "heroTitle": {
          "en-US": "Verify authenticity",
          "fr-FR": "Vérifier l'authenticité"
        },
        "heroSubtitle": {
          "en-US": "Verify authenticity",
          "fr-FR": "Vérifier l'authenticité"
        }
      },
      "loyaltySettings": {
        "tokens": [
          {
            "address": "0x9F8a7c2AEE85E24b2B3b58C20B9A46c83E2c7a12",
            "name": "Acme Loyalty Points",
            "symbol": "ACME-LP"
          }
        ]
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.