Retrieve a List of API Clients

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://apidocs.zerionsoftware.com/doc/iformbuilder-v81/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "iFormBuilder V81 MCP server": {
    "url": "https://apidocs.zerionsoftware.com/doc/iformbuilder-v81/mcp"
  }
}

Close
GET /profiles/{profile_id}/api_clients

The API clients (applications) of the profile. A client is {id, name, client_key, username, type, redirect_uris}. type lists the grants the client may use: jwt-bearer, authorization_code (which also allows refresh_token), password. username is the user the client acts as.

The client secret is never returned here: it is answered once, by POST .../api_clients and by POST .../api_clients/{client_id}/reset_secret. Internal (i_) clients are not part of this resource.

A SERVER user sees every client of any profile. A COMPANY user sees the clients of their own profile whose acting user is not a server admin. BASIC users are forbidden.

Field grammar applies to name, client_key and username.

Path parameters

  • profile_id string Required

    id of the profile

Query parameters

  • fields string

    Field grammar. Fields are id, name, client_key, username, type, redirect_uris; filters apply to name, client_key and username.

  • limit integer

    Maximum number of clients returned (100 at most).

  • offset integer

    Number of clients to skip.

Responses

  • 200 application/json

    OK

    Hide headers attribute Show headers attribute
    • Total-Count string
    Hide response attributes Show response attributes object
    • id integer
    • name string
    • client_key string
    • username string

      the user the client acts as

    • type array[string]

      grants the client may use; authorization_code also allows refresh_token

      Values are jwt-bearer, authorization_code, or password.

    • redirect_uris array[string(uri)]
  • 401

    Unauthorized - missing or invalid bearer token.

  • 403

    Forbidden - the token belongs to a BASIC user, or profile_id is not the caller's own profile.

  • 404

    Not Found - profile_id is not a valid profile id.

GET /profiles/{profile_id}/api_clients
curl \
 --request GET 'https://api.iformbuilder.com/exzact/api/v81/[servername]/profiles/self/api_clients' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
[
  {
    "id": 12,
    "name": "Portal sign-in",
    "client_key": "3f1c9b7e2a4d5c6f8e9a0b1c2d3e4f5a6b7c8d9e",
    "username": "portal_service",
    "type": [
      "password"
    ],
    "redirect_uris": []
  },
  {
    "id": 15,
    "name": "Field app",
    "client_key": "9e8d7c6b5a4f3e2d1c0b9a8f7e6d5c4b3a2f1e0d",
    "username": "inspector_1",
    "type": [
      "jwt-bearer",
      "authorization_code"
    ],
    "redirect_uris": [
      "https://app.example.com/oauth/callback"
    ]
  }
]