v1

latestOpenAPI 3.0.32026-07-24198357534.7 KB
Integration

This endpoint provides a list of Quable Apps

Retrieves the collection of IntegrationApp resources.

get/quable-apps

Query parameters

pageinteger

The collection page number

limitinteger

The number of items per page

paginationboolean

Enable or disable pagination

documentType.idstring
documentType.id[]string[]
permissionFeature[]string[]
slots[]string[]
searchstring
order[name]'asc' | 'desc'
typestring
type[]string[]
urlstring
url[]string[]
slugstring
slug[]string[]

Response

IntegrationApp collection

idstring uuid
slugstring
type'Custom' | 'AppStore'
urlstring uri
payloadobject
parametersstring[]
iconstring

Fontawesome icon name : https://fontawesome.com/icons

statusboolean

Status of the Quable App

helpDeskUrlstring

URL for the Help Desk

documentationUrlstring

URL for the Documentation

permissionFeaturesstring[]
dateCreatedstring date-time
dateModifiedstring date-time

Example response

[
  {
    "id": "c7ad508b-882d-4874-a00c-4b0eecb66e3d",
    "slug": "unique-slug",
    "type": "Custom",
    "url": "https://example.com/quable-app",
    "headers": {
      "Authorization": "Header value",
      "Content-Type": "Header value"
    },
    "payload": {
      "key": "value"
    },
    "documentType": {
      "id": "identifier_example"
    },
    "icon": "globe",
    "slots": [
      "document.action.bulk",
      "document.action.single",
      "document.page.tab",
      "page"
    ],
    "status": true,
    "helpDeskUrl": "https://support.example.com",
    "documentationUrl": "https://docs.example.com",
    "permissionFeatures": [
      "contributor",
      "validator",
      "..."
    ],
    "name": {
      "fr-FR": "fr-FR translation",
      "en-US": "en-US translation",
      "<*>": "..."
    },
    "description": {
      "fr-FR": "fr-FR translation",
      "en-US": "en-US translation",
      "<*>": "..."
    }
  }
]