Retrieve the Signed-in User's Access to a Page

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}/users/self/page_access/{page_id}

Returns the effective access of the user who owns the bearer token to one page, with subform inheritance applied. It answers the same question as the record endpoints' permission checks, so a client can decide whether to offer a form or subform without walking the subform tree itself.

The user is always the token's user. self is a literal path segment; there is no form of this endpoint that takes a user id.

Fields

  • can_view is true when the user holds view permission on the page through any assignment path (direct, user group, page group, or user group to page group), or inherits it from a form the page is a subform of. This is the page-level part of the check behind GET .../records/{record_id}; record assignments are not considered.
  • can_collect is the same with collect permission. It is the page-level part of the check behind POST .../records. It does not report edit or delete rights a BASIC user holds through view permission plus the EDIT_RECORD or DEL_RECORD role (the second path in the PUT and DELETE .../records checks), so can_collect: false does not mean the user cannot edit or delete records on the page.

Inheritance

Subforms are never assigned directly, so a subform's access comes from its parent forms. The walk goes up through subform elements in the same profile, at most 10 levels. A form shared into the profile does not pass its access down to its subforms.

can_collect: true through inheritance is a page-level answer. A record write is still checked against the parent form of each record it touches, so where one subform is used by two forms, a user assigned to only one of them may still get 403 writing records that belong to the other.

COMPANY and SERVER users

Users with company or server scope get true for both fields on any page they can reach in the profile, as the record endpoints treat them.

HTTP status

  • 200 the page exists in the profile; both fields may be false
  • 401 no valid bearer token
  • 403 another profile's profile_id and the caller is not a SERVER user
  • 404 unknown profile, invalid page_id, or the page is not in the profile
  • 429 the endpoint rate limit was reached

Rate limiting and freshness

The rate limit is per server per endpoint (apiEndpointLimits), shared by every caller on the server. A backend that calls this endpoint for many users, such as a portal BFF gating each form route, should use an internal client or ask for a raised limit rather than spend the shared budget.

Reads may come from a read replica, so a just-changed assignment can take a few seconds to show.

Headers

  • Authorization string

    e.g. Bearer {access_token}

Path parameters

  • profile_id string Required

    id of the profile

  • page_id number Required

    id of the page

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • page_id number Required

      the page id from the path

    • can_view boolean Required

      the user may view records on the page, directly or through a parent form

    • can_collect boolean Required

      the user may collect (create, edit, delete) records on the page, directly or through a parent form

  • 401

    Unauthorized - missing or invalid bearer token.

  • 403

    Forbidden - profile_id is not the caller's own profile (only SERVER users may name another profile).

  • 404

    Not Found - the profile does not exist, page_id is not a positive integer, or the page neither belongs to nor is shared into profile_id.

  • 429 application/json

    Too Many Requests - the per-server limit for this endpoint (apiEndpointLimits) was reached.

    Hide response attribute Show response attribute object
    • error_message string
GET /profiles/{profile_id}/users/self/page_access/{page_id}
curl \
 --request GET 'https://api.iformbuilder.com/exzact/api/v81/[servername]/profiles/self/users/self/page_access/{page_id}' \
 --header "Authorization: Bearer {access_token}"
Response examples (200)
{
  "page_id": 790777,
  "can_view": true,
  "can_collect": false
}
Response examples (429)
{
  "error_message": "API rate limit exceeded"
}