--- title: "Get All Domains for a Portal" url: "https://developer.yukisoftware.com/apis/yuki-platform-api-prod-1/versions/9cdc452d-fd77-4e06-8797-f61e76134ec9/operations/getAllDomains" --- > Full API specification: https://developer.yukisoftware.com/apis/yuki-platform-api-prod-1/versions/9cdc452d-fd77-4e06-8797-f61e76134ec9.md # Get All Domains for a Portal `GET` `/portals/{portal-id}/domains` Operation ID: `getAllDomains` This endpoint allows the retrieval of all domains belonging to a Portal. Ensure you have the necessary permissions before attempting to retrieve the domains list. You should have the **openid** and **yukiapi:domain:domains:read** scopes 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 ## Query parameters - `offset` (integer, optional) - Number of items to skip before collecting the result set. Defaults to 0; a negative value is rejected with 400. - `limit` (integer, optional) - Maximum number of items to return. Defaults to 20; a value outside 1-500 is rejected with 400. ## Header parameters - `Authorization` (string, required) - Bearer token for authentication ## Responses - `200` - Paged result of domains - `204` - No Content, with an empty body and no problem+json document, returned when the domain query cannot be read from the database. There is no errorCode to branch on, so treat it as a server-side failure and retry. A portal with no domains is a 200 with totalItems 0, not a 204. - `400` - Bad Request - `401` - Unauthorized - `403` - Forbidden - `500` - Internal Server Error ## OpenAPI definition ```yaml openapi: 3.0.0 info: title: Yuki Platform API Prod version: 1.0.77 servers: - url: https://apirest.yukiworks.be/api/v1 paths: /portals/{portal-id}/domains: get: x-environments: - development - pilot - production x-portal-visibility: - internal - trusted - prod x-required-roles: - any-of: - AccountantManagement - Accountant scope: portal summary: Get All Domains for a Portal description: >- This endpoint allows the retrieval of all domains belonging to a Portal. Ensure you have the necessary permissions before attempting to retrieve the domains list. You should have the **openid** and **yukiapi:domain:domains:read** scopes 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: getAllDomains tags: - Domain parameters: - $ref: "#/components/parameters/AuthorizationHeader" - $ref: "#/components/parameters/PortalIdPath" - $ref: "#/components/parameters/OffsetQuery" - $ref: "#/components/parameters/LimitQuery" security: - vismaConnectPortalUser: - openid - yukiapi:domain:domains:read responses: "200": $ref: "#/components/responses/GetDomainsPagedResponse" "204": description: > No Content, with an empty body and no problem+json document, returned when the domain query cannot be read from the database. There is no errorCode to branch on, so treat it as a server-side failure and retry. A portal with no domains is a 200 with totalItems 0, not a 204. "400": $ref: "#/components/responses/BadRequestResponse" "401": $ref: "#/components/responses/UnauthorizedResponse" "403": $ref: "#/components/responses/ForbiddenResponse" "500": $ref: "#/components/responses/InternalServerErrorResponse" security: - vismaConnectPortalUser: - openid - yukiapi:domain:domains:read components: parameters: AuthorizationHeader: name: Authorization in: header required: true description: Bearer token for authentication schema: type: string PortalIdPath: name: portal-id in: path required: true description: The portal id example: 3afb7b54-6144-4561-9a29-1148006f2375 schema: type: string OffsetQuery: name: offset in: query required: false description: Number of items to skip before collecting the result set. Defaults to 0; a negative value is rejected with 400. schema: type: integer minimum: 0 default: 0 LimitQuery: name: limit in: query required: false description: Maximum number of items to return. Defaults to 20; a value outside 1-500 is rejected with 400. schema: type: integer minimum: 1 maximum: 500 default: 20 responses: GetDomainsPagedResponse: description: Paged result of domains content: application/json: schema: allOf: - $ref: "#/components/schemas/PagedResult" - type: object properties: items: type: array items: $ref: "#/components/schemas/Domain" 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" InternalServerErrorResponse: description: Internal Server Error content: application/problem+json: schema: $ref: "#/components/schemas/InternalServerError" schemas: PagedResult: type: object properties: totalItems: type: integer description: Total number of items available example: 100 offset: type: integer description: Current offset in the list example: 10 limit: type: integer description: Maximum number of items returned example: 20 items: type: array items: type: object Domain: type: object properties: id: type: string example: e7ff8d6e-d82a-4649-be6e-523db02052d3 name: type: string example: Example Domain hid: type: string example: abcd1234 type: type: string example: Business status: $ref: "#/components/schemas/DomainStatusRead" country: type: string example: Netherlands owner: type: object properties: name: type: string example: John Doe email: type: string format: email example: john.doe@yuki.nl backoffice: type: object properties: selfAccountingActive: type: boolean example: true message: type: string example: All systems operational responsible: type: object properties: id: type: string example: user1 name: type: string example: JaneSmith backupResponsible: type: object properties: id: type: string example: user1 name: type: string example: JaneSmith controller: type: object properties: id: type: string example: user1 name: type: string example: JaneSmith accountManager: type: object properties: id: type: string example: user1 name: type: string example: JaneSmith createdDate: type: string format: date-time example: 2023-01-01T10:00:00Z createdBy: type: string example: Admin User modifiedDate: type: string format: date-time example: 2023-01-15T15:30:00Z modifiedBy: type: string example: Moderator lastUserLogin: type: string format: date-time example: 2023-01-20T09:00:00Z lastDocumentUpload: type: string format: date-time example: 2023-01-18T14:45:00Z comments: type: string nullable: true description: Free-form remarks stored on the domain. example: Migrated from legacy portal contract: type: object properties: bundle: type: string example: Medium startDate: type: string format: date example: 2023-01-01 endDate: type: string format: date example: 2024-01-01 BadRequestError: description: A 400 comes in two shapes that differ by title. A request that fails model binding never reaches the operation and carries the title below, with errors keyed by the rejected field. A request the operation itself rejects carries the title Validation Error, with errors keyed by the rejected field for a field check, or by the errorCode for a business rule. Both shapes carry errorCode, traceId and errors. allOf: - $ref: "#/components/schemas/ProblemDetails" example: type: https://httpstatuses.com/400 title: One or more validation errors occurred. status: 400 detail: The request contains invalid or malformed fields. See the errors property for details. instance: /example/bad-request traceId: 4bf92f3577b34da6a3ce929d0e0e4736 errorCode: validation:invalid_input errors: country: - The country field is required. UnauthorizedError: allOf: - $ref: "#/components/schemas/ProblemDetails" example: type: https://httpstatuses.com/401 title: Unauthorized status: 401 detail: Authentication is required. instance: /example/unauthorized traceId: 4bf92f3577b34da6a3ce929d0e0e4736 errorCode: authentication:unauthorized ForbiddenError: allOf: - $ref: "#/components/schemas/ProblemDetails" example: type: https://httpstatuses.com/403 title: Forbidden status: 403 detail: You do not have permission to access this resource. instance: /example/forbidden traceId: 4bf92f3577b34da6a3ce929d0e0e4736 errorCode: authentication:forbidden errors: authentication:forbidden: - You do not have permission to access this resource. InternalServerError: allOf: - $ref: "#/components/schemas/ProblemDetails" example: type: https://httpstatuses.com/500 title: Internal Server Error status: 500 detail: An unexpected error occurred. instance: /example/internal-server-error traceId: 4bf92f3577b34da6a3ce929d0e0e4736 errorCode: server:internal_error errors: server:internal_error: - An unexpected error occurred. DomainStatusRead: type: string enum: - Startup - Active - Inactive - Archived description: The status of the domain for read purposes. example: Active ProblemDetails: type: object description: Error body returned as application/problem+json on every 4xx and 5xx response. Beyond the standard problem members it carries the traceId, errorCode and errors extensions. properties: type: type: string description: URI reference identifying the problem type. Always https://httpstatuses.com/{status}, so it restates the status and carries no Yuki-specific meaning; branch on errorCode instead. example: https://httpstatuses.com/400 title: type: string description: Short, human-readable summary of the problem type, in English. example: Validation Error status: type: integer description: HTTP status code, repeated from the response status line. example: 400 detail: type: string description: Human-readable explanation of this specific occurrence. Free text meant for developers, not a stable contract - do not parse it. example: The company id is required. instance: type: string description: Optional. Path of the request as the API received it. The gateway fronts the API, so it is not always populated and it may differ from the URL the client called. example: /api/v1/companies/3afb7b54-6144-4561-9a29-1148006f2375 traceId: type: string description: Correlation id for the request - the 32-character hexadecimal W3C trace id taken from the incoming traceparent header, or a locally generated id when none was propagated. Quote it in support requests. example: 4bf92f3577b34da6a3ce929d0e0e4736 errorCode: type: string description: Stable machine-readable error identifier in {feature}:{error_type} form. This is the member to branch on, together with the status - not the feature prefix on its own. A request refused before it reaches the operation can answer 403 with validation:invalid_input, and an operation that fails on an unexpected internal state can answer 500 with that same code. example: companies:not_found errors: type: object description: Messages that explain the failure, grouped by key. Present on the errors raised while the request is being handled, not only on validation failures. It is absent from the errors that stop a request before it reaches the operation - the 401 for a missing or unaccepted token, the 403 for an absent scope or an unusable tenant claim, and the 500 for a session that could not be created - which carry only traceId and errorCode. Keys take one of two shapes - the name of the rejected field when the request failed model binding or field validation, otherwise the errorCode of the failure, repeating the errorCode member. additionalProperties: type: array items: type: string example: companies:validation_failed: - The company id is required. securitySchemes: vismaConnectPortalUser: type: oauth2 description: > Visma Connect token belonging to a **Portal User** - an employee of an accounting portal. The token's tenant must be a portal; the API resolves it to the caller's portal. The portal in the route must be that portal or one of the caller's master-accountant portals. 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: openid: Required on every request, together with the endpoint API scope 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 creation of Domain Users 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 ```