---
updatedAt: 2026-05-22T09:35:01.000Z
agentTools:
projectIndex: https://doc.fintecture.com/llms.txt
---
# List applications
List all applications linked to companies within the authenticated organisation's subtree.
Supports pagination and filtering by company_id.
Related resources can be included via `?include=bank_accounts`:
- To fetch without related resources, **omit** the `include` parameter.
- To include related bank accounts, pass `?include=bank_accounts`.
🔒 This endpoint requires an OAC (Organisation Access Credentials — ⚠️ Beta) access token with the applications:read scope.
# OpenAPI definition
```json
{
"openapi": "3.0.3",
"info": {
"title": "API EXPLORER",
"version": "3.0.0",
"description": "Public API\n",
"contact": {
"name": "Support",
"email": "noelia.rodriguez@fintecture.com"
}
},
"x-readme": {
"explorer-enabled": false,
"proxy-enabled": false,
"samples-languages": [
"curl",
"javascript",
"ruby"
]
},
"servers": [
{
"url": "https://api.sandbox.fintecture.com",
"description": "Sandbox server"
},
{
"url": "https://api.fintecture.com",
"description": "Production server"
}
],
"paths": {
"/v1/applications": {
"get": {
"security": [
{
"OAuth2Oac": [
"applications:read"
]
}
],
"tags": [
"applications"
],
"summary": "List applications",
"description": "List all applications linked to companies within the authenticated organisation's subtree.\nSupports pagination and filtering by company_id.\n\nRelated resources can be included via `?include=bank_accounts`:\n- To fetch without related resources, **omit** the `include` parameter.\n- To include related bank accounts, pass `?include=bank_accounts`.\n\n🔒 This endpoint requires an OAC (Organisation Access Credentials — ⚠️ Beta) access token with the applications:read scope.
\n",
"parameters": [
{
"in": "query",
"name": "filter[company_id]",
"required": false,
"description": "Filter applications by company UUID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "page[number]",
"required": false,
"description": "Page number (1-based)",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "page[size]",
"required": false,
"description": "Number of items per page (max 100)",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "include",
"required": false,
"description": "Comma-separated list of relationships to include",
"schema": {
"type": "string",
"enum": [
"bank_accounts"
]
}
},
{
"$ref": "#/components/parameters/Header-signature-req"
},
{
"$ref": "#/components/parameters/Header-date-req"
},
{
"$ref": "#/components/parameters/Header-xRequestId-req"
}
],
"responses": {
"200": {
"description": "Applications retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"data",
"meta"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/V1ApplicationResourceWithRelationships"
}
},
"included": {
"type": "array",
"description": "Optional related resources when requested via ?include=bank_accounts",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/BankAccountResourceBase"
}
]
}
},
"meta": {
"type": "object",
"additionalProperties": true,
"required": [
"total",
"page",
"size"
],
"properties": {
"total": {
"type": "integer",
"minimum": 0,
"description": "Total number of applications"
},
"page": {
"type": "integer",
"minimum": 1,
"description": "Current page number"
},
"size": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "Number of items per page"
}
}
}
}
},
"examples": {
"withoutInclude": {
"summary": "Response without including bank_accounts",
"value": {
"data": [
{
"type": "applications",
"id": "a1b2c3d4-1234-5678-9abc-def012345678",
"attributes": {
"app_name": "My Application",
"app_environment": "production",
"app_type": "shop",
"app_public_key": "-----BEGIN PUBLIC KEY-----\nMIIBI...",
"app_webhooks": [
{
"url": "https://example.com/webhook",
"events": [
"payment_session.status.payment_created"
],
"offset": 0,
"headers": []
}
],
"app_urls": [
{
"url": "https://example.com/return",
"type": "return"
}
]
},
"relationships": {
"bank_account": {
"data": {
"type": "bank_accounts",
"id": "b2c3d4e5-2345-6789-abcd-ef0123456789"
}
}
}
}
],
"meta": {
"total": 1,
"page": 1,
"size": 25
}
}
},
"withIncludeBankAccounts": {
"summary": "Response with ?include=bank_accounts",
"value": {
"data": [
{
"type": "applications",
"id": "a1b2c3d4-1234-5678-9abc-def012345678",
"attributes": {
"app_name": "My Application",
"app_environment": "production",
"app_type": "shop",
"app_public_key": "-----BEGIN PUBLIC KEY-----\nMIIBI...",
"app_webhooks": [
{
"url": "https://example.com/webhook",
"events": [
"payment_session.status.payment_created"
],
"offset": 0,
"headers": []
}
],
"app_urls": [
{
"url": "https://example.com/return",
"type": "return"
}
]
},
"relationships": {
"bank_account": {
"data": {
"type": "bank_accounts",
"id": "b2c3d4e5-2345-6789-abcd-ef0123456789"
}
}
}
}
],
"included": [
{
"type": "bank_accounts",
"id": "b2c3d4e5-2345-6789-abcd-ef0123456789",
"attributes": {
"iban": "FR7612345987650001112223334",
"swift_bic": "FTSBSESSXXX"
}
}
],
"meta": {
"total": 1,
"page": 1,
"size": 25
}
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400-BadRequest"
},
"401": {
"$ref": "#/components/responses/401-Unauthorized"
},
"403": {
"$ref": "#/components/responses/403-Forbidden"
},
"404": {
"$ref": "#/components/responses/404-NotFound"
},
"406": {
"$ref": "#/components/responses/406-NotAcceptable"
},
"500": {
"$ref": "#/components/responses/500-InternalServerError"
}
}
}
}
},
"components": {
"parameters": {
"Header-date-req": {
"name": "date",
"description": "RFC2822 formatted date.",
"schema": {
"$ref": "#/components/schemas/DateRfc2822"
},
"in": "header",
"required": true
},
"Header-signature-req": {
"name": "signature",
"description": "Signature is used to enforce security by signing request.
Related documentation can be found by clicking [here](https://doc.fintecture.com/docs/api-http-signature)",
"schema": {
"type": "string"
},
"in": "header",
"required": true
},
"Header-xRequestId-req": {
"name": "x-request-id",
"description": "uuid v4. Required in Redirect mode.",
"schema": {
"$ref": "#/components/schemas/IdentifierUuidV4"
},
"in": "header",
"required": true
}
},
"responses": {
"400-BadRequest": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse400"
}
}
},
"description": "bad request"
},
"401-Unauthorized": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse401"
}
}
},
"description": "unauthorized"
},
"403-Forbidden": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse403"
}
}
},
"description": "forbidden"
},
"404-NotFound": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse404"
}
}
},
"description": "resource not found"
},
"406-NotAcceptable": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse406"
}
}
},
"description": "not acceptable"
},
"500-InternalServerError": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse500"
}
}
},
"description": "internal server error"
}
},
"schemas": {
"V1ApplicationWebhookEvent": {
"type": "string",
"description": "Webhook event type",
"enum": [
"payment_session.status.payment_cancelled",
"payment_session.status.payment_created",
"payment_session.status.payment_expired",
"payment_session.status.payment_pending",
"payment_session.status.payment_partial",
"payment_session.status.payment_unsuccessful",
"payment_session.status.order_created",
"payment_session.transfer_states.completed",
"payment_session.transfer_states.pending",
"payment_session.transfer_states.processing",
"payment_session.transfer_states.rejected",
"payment_session.transfer_states.sent",
"payment_session.transfer_states.received",
"payment_session.transfer_states.overpaid",
"payment_session.transfer_states.returned",
"payment_session.refund_status.refund_accepted",
"payment_session.refund_status.refund_created",
"payment_session.refund_status.refund_partial",
"payment_session.refund_status.refund_initiated",
"payment_session.refund_status.refund_pending",
"payment_session.received_amount",
"customers.verifications.status.completed",
"customers.verifications.status.cancelled",
"customers.verifications.status.failed",
"emandates.status.active",
"emandates.status.cancelled",
"emandates.status.revoked",
"emandates.status.expired",
"emandates.status.ended",
"emandates.status.blocked"
]
},
"V1ApplicationWebhookHeader": {
"type": "object",
"required": [
"name",
"value"
],
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Header name"
},
"value": {
"type": "string",
"description": "Header value"
}
}
},
"V1ApplicationWebhook": {
"type": "object",
"required": [
"url",
"events",
"offset",
"headers"
],
"additionalProperties": false,
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "Webhook URL"
},
"events": {
"type": "array",
"minItems": 1,
"maxItems": 32,
"uniqueItems": true,
"description": "List of events to subscribe to",
"items": {
"$ref": "#/components/schemas/V1ApplicationWebhookEvent"
}
},
"offset": {
"type": "integer",
"minimum": 0,
"description": "Event offset for pagination"
},
"headers": {
"type": "array",
"description": "Custom headers to send with webhook requests",
"items": {
"$ref": "#/components/schemas/V1ApplicationWebhookHeader"
}
}
}
},
"V1ApplicationUrl": {
"type": "object",
"required": [
"url",
"type"
],
"additionalProperties": false,
"properties": {
"url": {
"type": "string",
"format": "uri",
"nullable": true,
"description": "Application URL"
},
"type": {
"type": "string",
"enum": [
"return",
"domain"
],
"description": "URL type (return or domain)"
}
}
},
"V1ApplicationResourceBase": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"enum": [
"applications"
],
"description": "The type of the resource object, always 'applications' for this schema"
},
"id": {
"type": "string",
"description": "The unique identifier (UUID) of the application object",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
},
"attributes": {
"type": "object",
"additionalProperties": false,
"properties": {
"app_name": {
"type": "string",
"description": "Name of the application"
},
"app_environment": {
"type": "string",
"enum": [
"sandbox",
"production"
],
"description": "Environment of the application"
},
"app_type": {
"type": "string",
"enum": [
"shop",
"developer",
"point_of_sale"
],
"description": "Type of the application"
},
"app_public_key": {
"type": "string",
"description": "Public key for the application"
},
"app_secret": {
"type": "string",
"description": "Secret key for the application (only returned on creation)",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
},
"app_webhooks": {
"description": "Webhook configurations for the application",
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/V1ApplicationWebhook"
}
},
"app_urls": {
"description": "URLs associated with the application",
"type": "array",
"items": {
"$ref": "#/components/schemas/V1ApplicationUrl"
},
"uniqueItems": true
},
"payment_policy": {
"$ref": "#/components/schemas/V1ApplicationPaymentPolicy"
}
}
}
}
},
"V1ApplicationResourceWithRelationships": {
"allOf": [
{
"$ref": "#/components/schemas/V1ApplicationResourceBase"
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"relationships": {
"type": "object",
"additionalProperties": false,
"properties": {
"bank_account": {
"type": "object",
"description": "Bank account associated with this application",
"additionalProperties": false,
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"enum": [
"bank_accounts"
]
},
"id": {
"type": "string",
"description": "The unique identifier (UUID) of the bank account",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
}
}
}
}
}
}
}
}
}
]
},
"V1ApplicationPaymentPolicy": {
"title": "Application Payment Policy (Enum)",
"description": "Payment policy for the application. Controls which payment rail is used.",
"type": "string",
"enum": [
"INST",
"SEPA"
],
"example": "SEPA"
},
"BankAccountResourceBase": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"id",
"attributes"
],
"properties": {
"type": {
"type": "string",
"enum": [
"bank_accounts"
],
"description": "The type of the resource object, always 'bank_accounts' for this schema"
},
"id": {
"type": "string",
"description": "The unique identifier (UUID) of the bank account",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
},
"attributes": {
"type": "object",
"additionalProperties": false,
"properties": {
"iban": {
"type": "string",
"description": "International Bank Account Number",
"minLength": 15,
"maxLength": 34
},
"swift_bic": {
"type": "string",
"description": "SWIFT/BIC code of the bank",
"maxLength": 11
},
"name": {
"type": "string",
"description": "Name of the bank"
},
"commercial_name": {
"type": "string",
"description": "Commercial name for the bank account"
},
"description": {
"type": "string",
"description": "Free-text description for the bank account",
"maxLength": 255
}
}
}
}
},
"APIResponse400": {
"title": "400 API Response",
"description": "Definition of the standard API reponse when a 400",
"type": "object",
"properties": {
"status": {
"format": "int32",
"description": "HTTP status code",
"type": "integer",
"example": 400
},
"code": {
"type": "string",
"enum": [
"bad_request",
"provider_error"
],
"example": "bad_request"
},
"log_id": {
"allOf": [
{
"$ref": "#/components/schemas/IdentifierUuidV4"
},
{
"description": "Log unique identifier"
}
]
},
"errors": {
"description": "Errors returned",
"type": "array",
"items": {
"$ref": "#/components/schemas/APIResponse400Error"
}
}
}
},
"APIResponse400Error": {
"title": "API Response 400 Error",
"description": "API Response 400 Error description",
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"bad_request",
"customer_unknown",
"account_unknown",
"session_id_invalid_or_expired",
"invalid_field",
"mandatory_field_missing",
"invalid_debited_account"
],
"example": "bad_request"
},
"title": {
"description": "Title message",
"type": "string",
"example": "Bad request"
},
"message": {
"description": "Error message",
"type": "string",
"example": "Invalid parameters or malformed syntax."
}
}
},
"APIResponse401": {
"title": "401 API Response",
"description": "Definition of the standard API reponse when a 401",
"type": "object",
"properties": {
"status": {
"format": "int32",
"description": "HTTP status code",
"type": "integer",
"example": 401
},
"code": {
"type": "string",
"enum": [
"unauthorized"
],
"example": "unauthorized"
},
"log_id": {
"allOf": [
{
"$ref": "#/components/schemas/IdentifierUuidV4"
},
{
"description": "Log unique identifier"
}
]
},
"errors": {
"description": "Errors returned",
"type": "array",
"items": {
"$ref": "#/components/schemas/APIResponse401Error"
}
}
}
},
"APIResponse401Error": {
"title": "API Response 401 Error",
"description": "API Response 401 Error description",
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"invalid_token",
"invalid_scopes",
"invalid_code",
"invalid_app_id",
"invalid_app_url"
],
"example": "bad_request"
},
"title": {
"description": "Title message",
"type": "string",
"example": "Invalid token"
},
"message": {
"description": "Error message",
"type": "string",
"example": "The token is either invalid or expired."
}
}
},
"APIResponse403": {
"title": "403 API Response",
"description": "Definition of the standard API reponse when a 403",
"type": "object",
"properties": {
"status": {
"format": "int32",
"description": "HTTP status code",
"type": "integer",
"example": 403
},
"code": {
"type": "string",
"enum": [
"forbidden"
],
"example": "forbidden"
},
"log_id": {
"allOf": [
{
"$ref": "#/components/schemas/IdentifierUuidV4"
},
{
"description": "Log unique identifier"
}
]
},
"errors": {
"description": "Errors returned",
"type": "array",
"items": {
"$ref": "#/components/schemas/APIResponse403Error"
}
}
}
},
"APIResponse403Error": {
"title": "API Response 403 Error",
"description": "API Response 403 Error description",
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"forbidden"
],
"example": "forbidden"
},
"title": {
"description": "Title message",
"type": "string",
"example": "Forbidden"
},
"message": {
"description": "Error message",
"type": "string",
"example": "Access Forbidden."
}
}
},
"APIResponse404": {
"title": "404 API Response",
"description": "Definition of the standard API reponse when a 404",
"type": "object",
"properties": {
"status": {
"format": "int32",
"description": "HTTP status code",
"type": "integer",
"example": 404
},
"code": {
"type": "string",
"enum": [
"not_found"
],
"example": "not_found"
},
"log_id": {
"allOf": [
{
"$ref": "#/components/schemas/IdentifierUuidV4"
},
{
"description": "Log unique identifier"
}
]
},
"errors": {
"description": "Errors returned",
"type": "array",
"items": {
"$ref": "#/components/schemas/APIResponse404Error"
}
}
}
},
"APIResponse404Error": {
"title": "API Response 404 Error",
"description": "API Response 404 Error description",
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"not_found"
],
"example": "not_found"
},
"title": {
"description": "Title message",
"type": "string",
"example": "Not found"
},
"message": {
"description": "Error message",
"type": "string",
"example": "The requested resource could not be found. The requested resource either does not exist or is temporarily down."
}
}
},
"APIResponse406": {
"title": "406 API Response",
"description": "Definition of the standard API reponse when a 406",
"type": "object",
"properties": {
"status": {
"format": "int32",
"description": "HTTP status confirmation",
"type": "integer",
"example": 406
},
"code": {
"type": "string",
"enum": [
"ERR_NOT_ACCEPTABLE"
],
"example": "ERR_NOT_ACCEPTABLE"
},
"log_id": {
"allOf": [
{
"$ref": "#/components/schemas/IdentifierUuidV4"
},
{
"description": "Log unique identifier"
}
]
},
"errors": {
"description": "Errors returned",
"type": "array",
"items": {
"$ref": "#/components/schemas/APIResponse406Error"
}
}
}
},
"APIResponse406Error": {
"title": "API Response 406 Error",
"description": "API Response 406 Error description",
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"SCHEMA_VALIDATION_ERROR"
],
"example": "SCHEMA_VALIDATION_ERROR"
},
"title": {
"description": "Title message",
"type": "string",
"example": "Schema validation error"
},
"detail": {
"description": "Error message",
"type": "string",
"example": "must NOT have fewer than 1 characters"
}
}
},
"APIResponse500": {
"title": "500 API Response",
"description": "Definition of the standard API reponse when a 500",
"type": "object",
"properties": {
"status": {
"format": "int32",
"description": "HTTP status code",
"type": "integer",
"example": 500
},
"code": {
"type": "string",
"enum": [
"internal_server_error"
],
"example": "internal_server_error"
},
"log_id": {
"allOf": [
{
"$ref": "#/components/schemas/IdentifierUuidV4"
},
{
"description": "Log unique identifier"
}
]
},
"errors": {
"description": "Errors returned",
"type": "array",
"items": {
"$ref": "#/components/schemas/APIResponse500Error"
}
}
}
},
"APIResponse500Error": {
"title": "API Response 500 Error",
"description": "API Response 500 Error description",
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"internal_server_error"
],
"example": "internal_server_error"
},
"title": {
"description": "Title message",
"type": "string",
"example": "Internal Server Error"
},
"message": {
"description": "Error message",
"type": "string",
"example": "An internal error has occurred. If the error persists, please contact our support."
}
}
},
"DateRfc2822": {
"title": "Date in rfc 2822 format",
"description": "Date as described in rfc 2822 format",
"type": "string",
"example": "Thu, 18 Jun 2020 18:14:15 GMT"
},
"IdentifierUuidV4": {
"title": "UUID V4 identifier",
"description": "UUID V4 identifier",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"type": "string",
"example": "dc5b0048-2a80-4a22-b2f9-fad7d72f074d"
}
},
"securitySchemes": {
"OAuth2Oac": {
"type": "oauth2",
"x-default": "",
"description": "OAC (Organisation Access Credentials — ⚠️ Beta) access token, sent as `Authorization: Bearer {access_token}`.\n\nObtain it from `POST /oauth/accesstoken` with `grant_type=client_credentials`, authenticating with the OAC `client_id` and `client_secret` as Basic credentials (`Basic base64({client_id}:{client_secret})`). The token is valid for 1 hour. See the [OAC guide](https://doc.fintecture.com/docs/request-an-oac-access-token).\n\nThe token only grants the scopes requested when it was created; each endpoint declares the scopes it requires.\n",
"flows": {
"clientCredentials": {
"tokenUrl": "/oauth/accesstoken",
"scopes": {
"organisations:read": "Read access to organisation nodes",
"organisations:write": "Write access to organisation nodes",
"companies:read": "Read access to companies",
"companies:write": "Write access to companies",
"users:read": "Read access to users and memberships",
"users:write": "Write access to users and memberships",
"applications:read": "Read access to applications",
"applications:write": "Write access to applications",
"bank_accounts:read": "Read access to bank accounts",
"bank_accounts:write": "Write access to bank accounts"
}
}
}
}
}
},
"tags": [
{
"name": "applications",
"description": "Application related endpoints",
"x-displayName": "Application"
}
]
}
```