# Get a portal

Get a Portal

Endpoint: GET /portals/{id}
Version: 2.0.0
Security: bearerToken

## Path parameters:

  - `id` (string, required)
    The unique ID of the Portal

## Response 200 fields (application/json):

  - `result` (object, required)

  - `result.id` (string, required)
    The unique ID of the [Portal](#tag/Portals)
    Example: "55f9964c-095d-4b8b-bb5e-4118d2e76ad0"

  - `result.accountId` (string, required)
    The unique ID of the Account the [Portal](#tag/Portals) belongs to
    Example: "cfb665ca-ce35-4418-b9d5-70ee815db4bd"

  - `result.name` (string, required)
    Name of the [Portal](#tag/Portals)
    Example: "Reseller portal"

  - `result.currentSlug` (string, required)
    A human readable unique identifier, used in the Dash portal URL
    Example: "reseller-portal"

  - `result.slugs` (array, required)
    The set of all slugs that have ever been used, maintained so that old share URLs can still work
    Example: ["reseller-portal","old-slug-here"]

  - `result.whitelistedFolderFieldOptionIds` (array, required)
    The folder [FieldOption](#tag/Field-Options)s which portal users will have permission to view/download assets from.
    Example: ["4cb261ad-dffb-414e-89cf-6902e3031d44","4e14dc90-eb7b-4fd2-87e5-e8968c236ec0"]

  - `result.welcomeMessage` (object, required)

  - `result.welcomeMessage.title` (string,null)
    Optional title of the Welcome Message
    Example: "Welcome to our reseller portal"

  - `result.welcomeMessage.body` (string,null)
    Optional body of text displayed below the title in the Welcome Message
    Example: "Take a look around our reseller portal and quickly find all the assets you need. Happy browsing!"

  - `result.showRecentlyAddedAssets` (boolean, required)
    Whether this portal should include a preview of recently added assets
    Example: true

  - `result.passcode` (string,null)
    A passcode that must be provided when viewing a portal.  Note that this is NOT a password and as such is stored in plain text
    Example: "LetMeInPlease"

  - `result.assetPermittedActions` (string, required)
    Permissions users have on assets they are viewing
    Enum: "VIEW", "VIEW_AND_DOWNLOAD"

  - `permittedActions` (array, required)

  - `permittedActions.resourceType` (string, required)
    Defines the type of the resource that is being permitted to act on
    Enum: "ACCOUNT", "ASSET", "ASSET_SHARES", "ASSETS", "ASSETS_IN_NO_FOLDERS", "CLOUD_CONNECTION", "CLOUD_CONNECTIONS", "COLLECTION", "COLLECTIONS", "COMMENT", "CUSTOM_TERMS_AND_CONDITIONS", "EMAILS", "FIELD_OPTION", "FIELDS", "INDESIGN_EXTENSION", "INTELLIGENCE_SETTINGS", "METADATA_SCHEMA", "PORTALS", "PRESET_SIZES", "REFERRAL", "SAVED_SEARCHES", "SHOPIFY_INTEGRATION_V2", "SUBSCRIPTION", "THEME", "TOP_LEVEL_FIELD_OPTIONS", "USER_GROUPS", "WEB_USAGE"

  - `permittedActions.resourceId` (string)
    The ID of the resource that is being permitted to act on.  This may be null if the permission is on the resource type as a whole rather than an individual instance.
    Example: "7af90a8b-7ccd-430f-a85d-e8614015bc47"

  - `permittedActions.action` (string, required)
    Defines the action that is being permitted
    Enum: "ADD_ASSET_TO_COLLECTION", "ADD_COLLABORATOR_TO_COLLECTION", "APPROVE_ASSETS", "CONFIGURE_SHOPIFY_INTEGRATION", "CREATE_ASSET_SHARES", "CREATE_ASSETS", "CREATE_CHILD_FIELD_OPTIONS", "CREATE_CLOUD_CONNECTIONS", "CREATE_COLLECTIONS", "CREATE_COLLECTION_COMMENTS", "CREATE_COMMENTS", "CREATE_EMBEDDABLE_LINKS", "CREATE_PORTALS", "CREATE_SAVED_SEARCHES", "CREATE_SUBSCRIPTION", "CREATE_TOP_LEVEL_FIELD_OPTIONS", "CUSTOMISE_EMAILS", "DELETE_ASSET", "DELETE_CLOUD_CONNECTION", "DELETE_COLLECTION", "DELETE_COMMENT", "DOWNLOAD_ASSET", "DOWNLOAD_INDESIGN_EXTENSION", "EDIT_ACCOUNT", "EDIT_ASSET", "EDIT_CLOUD_CONNECTION", "EDIT_COLLECTION", "EDIT_COMMENT", "EDIT_FIELDS", "EDIT_INTELLIGENCE_SETTINGS_ADDRESS_LOOKUP", "EDIT_INTELLIGENCE_SETTINGS_IMAGE_AUTO_TAGGING", "EDIT_INTELLIGENCE_SETTINGS_IMAGE_FACIAL_REC", "EDIT_INTELLIGENCE_SETTINGS_TEXT_IN_IMAGE", "EDIT_INTELLIGENCE_SETTINGS_VIDEO_AUTO_TAGGING", "EDIT_INTELLIGENCE_SETTINGS_VIDEO_FACIAL_REC", "EDIT_METADATA_SCHEMA", "EDIT_PRESET_SIZES", "EDIT_THEME", "EDIT_USER_GROUPS", "EXPORT_TO_SHOPIFY", "IMPORT_ASSETS_OR_METADATA", "IMPORT_FROM_CLOUD", "MAKE_REFERRAL", "MANAGE_CUSTOM_TERMS_AND_CONDITIONS", "PROMOTE_ASSETS_TO_LIVE", "PUT_ASSETS_IN_NO_FOLDER", "REMOVE_ASSET_FROM_COLLECTION", "REMOVE_COLLABORATOR_FROM_COLLECTION", "RUN_NATURAL_LANGUAGE_SEARCH", "SEARCH_FOR_VIEW", "SET_ASSETS_LIFECYCLE_STATUS_BINNED", "SET_ASSETS_LIFECYCLE_STATUS_LIVE", "UPDATE_METADATA_WITH_FIELD_OPTION", "USE_CANVA_INTEGRATION", "USE_CLOUD_CONNECTION", "USE_COLLECTIONS", "USE_EMBEDDABLE_LINKS", "VIEW_ASSET", "VIEW_ASSET_EVENTS", "VIEW_ASSET_FACES", "VIEW_ASSETS_IN_NO_FOLDER", "VIEW_CLOUD_CONNECTION", "VIEW_COLLECTION", "VIEW_COMMENTS", "VIEW_WEB_USAGE"

## Response 4XX fields (application/json):

  - `timestamp` (string)
    The datetime that the error occurred in ISO offset format
    Example: "2021-02-16T16:21:58.640+00:00"

  - `status` (integer)
    The HTTP status code of the error
    Example: 401

  - `error` (string)
    The title of the error
    Example: "Unauthorized"

  - `message` (string)
    A more detailed error message

  - `path` (string)
    The path that was called which led to the error
    Example: "/folder-settings"