--- title: "Get Portal info" url: "https://developer.yukisoftware.com/apis/yuki-platform-api-prod-1/versions/1237fe18-1f8f-477a-8f52-b3546dd409bf/operations/getPortal" --- > Full API specification: https://developer.yukisoftware.com/apis/yuki-platform-api-prod-1/versions/1237fe18-1f8f-477a-8f52-b3546dd409bf.md # Get Portal info `GET` `/portals/{portal-id}` Operation ID: `getPortal` This endpoint retrieves information about a portal using its unique portal ID. Ensure you have the necessary permissions before accessing this endpoint. You should have yukiapi:portal:portals:read scope to access this endpoint. **Authorization** Called with a **Portal User** token - an employee of an accounting portal. The caller must hold at least one of these roles in the portal: `AccountantManagement`, `Accountant`. ## Path parameters - `portal-id` (string, required) - The portal id ## Header parameters - `Authorization` (string, required) - Bearer token for authentication - `Content-Type` (string, required) - Content type of the request body ## Responses - `200` - Portal object - `400` - Bad Request - `401` - Unauthorized - `403` - Forbidden - `404` - Not Found - `500` - Internal Server Error ## OpenAPI definition ```yaml openapi: 3.0.0 info: title: Yuki Platform API Prod version: 1.0.52 servers: - url: https://apirest.yukiworks.com/api/v1 paths: /portals/{portal-id}: get: x-environments: - development - pilot - production x-portal-visibility: - internal - trusted - prod x-required-roles: - any-of: - AccountantManagement - Accountant scope: portal summary: Get Portal info description: >- This endpoint retrieves information about a portal using its unique portal ID. Ensure you have the necessary permissions before accessing this endpoint. You should have yukiapi:portal:portals:read scope to access this endpoint. **Authorization** Called with a **Portal User** token - an employee of an accounting portal. The caller must hold at least one of these roles in the portal: `AccountantManagement`, `Accountant`. operationId: getPortal tags: - Portal parameters: - $ref: "#/components/parameters/AuthorizationHeader" - $ref: "#/components/parameters/ContentTypeHeader" - $ref: "#/components/parameters/PortalIdPath" security: - vismaConnectPortalUser: - yukiapi:portal:portals:read responses: "200": $ref: "#/components/responses/PortalResponse" "400": $ref: "#/components/responses/BadRequestResponse" "401": $ref: "#/components/responses/UnauthorizedResponse" "403": $ref: "#/components/responses/ForbiddenResponse" "404": $ref: "#/components/responses/NotFoundResponse" "500": $ref: "#/components/responses/InternalServerErrorResponse" security: - vismaConnectPortalUser: - yukiapi:portal:portals:read components: parameters: AuthorizationHeader: name: Authorization in: header required: true description: Bearer token for authentication schema: type: string ContentTypeHeader: name: Content-Type in: header required: true description: Content type of the request body schema: type: string default: application/json PortalIdPath: name: portal-id in: path required: true description: The portal id example: 3afb7b54-6144-4561-9a29-1148006f2375 schema: type: string responses: PortalResponse: description: Portal object content: application/json: schema: $ref: "#/components/schemas/Portal" BadRequestResponse: description: Bad Request content: application/problem+json: schema: $ref: "#/components/schemas/BadRequestError" UnauthorizedResponse: description: Unauthorized content: application/problem+json: schema: $ref: "#/components/schemas/UnauthorizedError" ForbiddenResponse: description: Forbidden content: application/problem+json: schema: $ref: "#/components/schemas/ForbiddenError" NotFoundResponse: description: Not Found content: application/problem+json: schema: $ref: "#/components/schemas/NotFoundError" InternalServerErrorResponse: description: Internal Server Error content: application/problem+json: schema: $ref: "#/components/schemas/InternalServerError" schemas: Portal: type: object properties: id: type: string description: The unique ID of the Portal example: 3afb7b54-6144-4561-9a29-1148006f2375 name: type: string description: Name of the Portal example: Example Portal country: type: string description: Country of the Portal in ISO-3166 (2 char) format contact: type: object description: Contact of the Portal properties: id: type: string description: ID of the contact example: 3afb7b54-6144-4561-9a29-1148006f2375 name: type: string description: Name of the contact subPortals: type: array description: The Portal's direct (1st generation) child portals items: type: object properties: id: type: string description: The unique ID of the child Portal example: 3afb7b54-6144-4561-9a29-1148006f2375 name: type: string description: Name of the child Portal BadRequestError: allOf: - $ref: "#/components/schemas/ProblemDetails" example: type: https://example.com/errors/bad-request title: Bad Request status: 400 detail: The request is invalid or malformed. instance: /example/bad-request UnauthorizedError: allOf: - $ref: "#/components/schemas/ProblemDetails" example: type: https://example.com/errors/unauthorized title: Unauthorized status: 401 detail: Authentication is required. instance: /example/unauthorized ForbiddenError: allOf: - $ref: "#/components/schemas/ProblemDetails" example: type: https://example.com/errors/forbidden title: Forbidden status: 403 detail: You do not have permission to access this resource. instance: /example/forbidden NotFoundError: allOf: - $ref: "#/components/schemas/ProblemDetails" example: type: https://example.com/errors/not-found title: Not Found status: 404 detail: The requested resource could not be found. instance: /example/not-found InternalServerError: allOf: - $ref: "#/components/schemas/ProblemDetails" example: type: https://example.com/errors/internal-server-error title: Internal Server Error status: 500 detail: An unexpected error occurred. instance: /example/internal-server-error ProblemDetails: type: object properties: type: type: string example: https://dev.yuki.nl/errors/problem title: type: string example: Problem status: type: integer example: 500 detail: type: string example: An unexpected error occurred. instance: type: string example: /example/endpoint securitySchemes: vismaConnectPortalUser: type: oauth2 description: > Visma Connect token belonging to a **Portal User** - an employee of an accounting portal. The token carries a `portal-id` claim, and the portal it identifies must match the portal in the route. Unless an endpoint says otherwise, the caller's roles are resolved against the portal. flows: authorizationCode: authorizationUrl: https://connect.identity.stagaws.visma.com/connect/authorize tokenUrl: https://connect.identity.stagaws.visma.com/connect/token scopes: yukiapi:domain:companies:read: Allows reading information of a Company yukiapi:domain:companies:update: Allows the update of a Company yukiapi:portal:portals:read: Allows reading portal information yukiapi:domain:domains:read: Allows reading domains information yukiapi:domain:domains:write: Allows modifications of domain information, may include create/update yukiapi:domain:domains:create: Allows the creation of new domains yukiapi:domain:domains:update: Allows updating existing domain information yukiapi:domain:domains:delete: Allows the deletion of domain data yukiapi:domain:users:read: Allows reading of domain user data yukiapi:domain:users:write: Allows the update of domain user data, may include create/update yukiapi:domain:users:update: Allows updating a Domain User yukiapi:domain:users:delete: Allows the deletion of Domain Users yukiapi:portal:portals:write: Allows updating existing portal information yukiapi:portal:users:read: Allows reading Portal user data yukiapi:portal:users:write: Allows the update of Portal user, may include create/update yukiapi:portal:users:update: Allows updating an existing Portal User yukiapi:portal:users:delete: Allows the deletion of a Portal User ```