# /portal/{portalId}

Retrieve detailed information for a specific portal, including associated forms and users.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Formstack API v2025.0",
    "version": "0.0.4"
  },
  "servers": [
    {
      "url": "https://www.formstack.com/api/v2025",
      "description": "Production server"
    },
    {
      "url": "https://staging-formstack.com/api/v2025",
      "description": "Staging server"
    },
    {
      "url": "https://dev-formstack.com/api/v2025",
      "description": "Development server"
    }
  ],
  "paths": {
    "/portal/{portalId}": {
      "get": {
        "tags": [
          "Portals",
          "Classic"
        ],
        "description": "Retrieve detailed information for a specific portal, including associated forms and users.",
        "operationId": "getPortal",
        "parameters": [
          {
            "name": "portalId",
            "in": "path",
            "description": "Unique identifier of the portal to retrieve",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PortalDetailedApiDto"
                }
              }
            }
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Internal Server Error"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "PortalDetailedApiDto": {
        "title": "Portal Detailed",
        "description": "Portal detailed response",
        "properties": {
          "id": {
            "description": "Unique identifier of the portal",
            "type": "integer",
            "nullable": false
          },
          "name": {
            "description": "Name of the portal",
            "type": "string",
            "nullable": false
          },
          "description": {
            "description": "Description of the portal",
            "type": "string",
            "nullable": true
          },
          "avatar": {
            "description": "Avatar image URL for the portal",
            "type": "string",
            "nullable": true
          },
          "created": {
            "description": "Creation timestamp of the portal (Y-m-d H:i:s format)",
            "type": "string",
            "nullable": true
          },
          "timezone": {
            "description": "Timezone of the portal",
            "type": "string",
            "nullable": true
          },
          "participantCount": {
            "description": "Number of participants in the portal",
            "type": "integer",
            "nullable": true
          },
          "forms": {
            "description": "List of forms associated with the portal",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PortalFormApiDto"
            },
            "nullable": true
          },
          "users": {
            "description": "List of users associated with the portal",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PortalUserApiDto"
            },
            "nullable": true
          }
        },
        "type": "object"
      },
      "PortalDetailsDeadlineApiDto": {
        "title": "Portal details deadline",
        "description": "Portal details deadline response",
        "properties": {
          "frequency": {
            "description": "How often the deadline recurs (daily, weekly, monthly)",
            "type": "string",
            "nullable": true
          },
          "dueTime": {
            "description": "Time when the deadline is due",
            "type": "string",
            "nullable": true
          },
          "earlyReminderHours": {
            "description": "Number of hours before deadline to send early reminder",
            "type": "integer",
            "nullable": true
          },
          "dueDay": {
            "description": "Day when the deadline is due (for weekly/monthly frequencies)",
            "type": "string",
            "nullable": true
          },
          "earlyReminderDays": {
            "description": "Number of days before deadline to send early reminder",
            "type": "integer",
            "nullable": true
          },
          "dueDate": {
            "description": "Due date of the portal deadline",
            "type": "string",
            "nullable": true
          }
        },
        "type": "object"
      },
      "PortalFormApiDto": {
        "title": "Portal Form",
        "description": "Portal form response",
        "properties": {
          "id": {
            "description": "Unique identifier of the portal form",
            "type": "integer",
            "nullable": false
          },
          "name": {
            "description": "Name of the portal form",
            "type": "string",
            "nullable": true
          },
          "completedUserCount": {
            "description": "Number of users who have completed the portal form",
            "type": "integer",
            "nullable": true
          },
          "description": {
            "description": "Description of the portal form",
            "type": "string",
            "nullable": true
          },
          "formUrl": {
            "description": "URL of the portal form",
            "type": "string",
            "nullable": true
          },
          "formId": {
            "description": "Form ID of the portal form",
            "type": "integer",
            "nullable": true
          },
          "deadline": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/PortalDetailsDeadlineApiDto"
              }
            ],
            "nullable": true,
            "description": "Deadline configuration for the portal form"
          },
          "usersPerformance": {
            "description": "Performance data for users in the portal form",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PortalUserPerformanceApiDto"
            },
            "nullable": true
          }
        },
        "type": "object"
      },
      "PortalUserApiDto": {
        "title": "Portal User",
        "description": "Portal user response",
        "properties": {
          "id": {
            "description": "Unique identifier of the portal user",
            "type": "integer",
            "nullable": false
          },
          "avatarUrl": {
            "description": "Avatar URL of the portal user",
            "type": "string",
            "nullable": false
          },
          "email": {
            "description": "Email address of the portal user",
            "type": "string",
            "nullable": false
          },
          "name": {
            "description": "Name of the portal user",
            "type": "string",
            "nullable": false
          },
          "type": {
            "description": "Type of the portal user (account or external)",
            "type": "string",
            "nullable": false
          }
        },
        "type": "object"
      },
      "PortalUserPerformanceApiDto": {
        "title": "Portal User Performance",
        "description": "Portal user performance response",
        "properties": {
          "id": {
            "description": "Unique identifier of the portal user",
            "type": "integer",
            "nullable": false
          },
          "lastSubmissionId": {
            "description": "ID of the user's most recent submission",
            "type": "integer",
            "nullable": true
          },
          "formCompletionDate": {
            "description": "Date when the user completed the form",
            "type": "string",
            "nullable": true
          }
        },
        "type": "object"
      }
    }
  },
  "tags": [
    {
      "name": "Portals",
      "description": "Portals provide a branded hub where users access a curated collection of forms. Use these endpoints to manage a portal and its forms and users—copying (to create new portals), editing, and deleting portals, adding, editing, and removing portal forms, managing portal users, and setting or removing the portal avatar."
    },
    {
      "name": "Classic",
      "description": "Classic"
    }
  ]
}
```