List of available API for support user

List Available APIs for Support User

This endpoint retrieves an enumerated list of all API operations that are accessible to support users on the Netevia Banking platform. Each item in the response describes an available API by its name, numeric identifier, human-readable description, logical group, and the specific endpoint paths associated with it. This is useful for support tooling, dashboards, or administrative interfaces that need to discover and display available API capabilities dynamically.

Endpoint

GET /api/enums/supportAPI

Authentication

Bearer token required. Obtain via:

POST https://api.banking.netevia.dev/api/auth/v2

Include in header: Authorization: Bearer {token}
Token lifetime: 10 minutes. Refresh via POST /api/auth/refresh.

When to use

Use this endpoint when building support portals or administrative tools that need a complete, up-to-date catalog of API operations available to support users. It is also useful for validating access scopes or rendering dynamic API navigation menus within internal tooling.

Response

200 OK

FieldTypeDescription
namestring (nullable)The display name of the API operation
idinteger (int32)Numeric identifier for the enum entry
descriptionstring (nullable)Human-readable description of the API operation
groupNamestring (nullable)The logical group or category this API belongs to
endpointsarray of strings (nullable)List of endpoint paths associated with this API operation
[
  {
    "name": "GetCustomerProfile",
    "id": 101,
    "description": "Retrieve a customer's profile details by profile ID",
    "groupName": "Customer",
    "endpoints": [
      "/api/customer/{profileId}",
      "/api/customer/{profileId}/details"
    ]
  },
  {
    "name": "ListFinancialAccounts",
    "id": 205,
    "description": "List all financial accounts for a given customer",
    "groupName": "Accounts",
    "endpoints": [
      "/api/accounts/{profileId}"
    ]
  },
  {
    "name": "GetTransactionHistory",
    "id": 310,
    "description": "Retrieve transaction history for a financial account",
    "groupName": "Transactions",
    "endpoints": [
      "/api/transactions/{accountId}"
    ]
  }
]

Error Codes

CodeWhen it happens
401Token missing, expired, or invalid
403Insufficient permissions — caller does not have support user access
500Internal server error

Common Mistakes

  • Calling this endpoint without a valid Bearer token will result in a 401 error; ensure the token has not expired (10-minute lifetime).
  • This endpoint is scoped to support users — authenticating with a partner or standard customer token may result in an empty list or a 403 error depending on role configuration.
  • Do not cache the response for extended periods; the list of available APIs may change as the platform is updated.

Related Endpoints

  • GET /api/enums — Returns the general enumeration list for all users
  • POST /api/auth/v2 — Obtain a Bearer token for authentication
  • POST /api/auth/refresh — Refresh an expiring Bearer token

Example

curl -X GET https://api.banking.netevia.dev/api/enums/supportAPI \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json