The API token used for authenticating the request. This must be passed as a header parameter. To generate an API token, go to Settings > Knowledge base portal > API tokens. This token must correspond to a valid workspace and permission level.
1-based page number. Each page returns up to 5 reader groups. Default: 1.
When true, the group response omits its readers (lighter payload). When false, readers are included.
Operation succeeded. Inspect the response envelope's success flag and the result/data payload.
A typical page response — two groups with different access scopes: one project-wide, one scoped to a workspace, and (in real responses) one excluded for brevity.
{
"result": [
{
"reader_group_id": "047ec4da-d8d3-4bfe-ae83-fff9f4e1f6ae",
"title": "Enterprise Customers",
"description": "Readers from enterprise-tier customer accounts.",
"associated_readers": [
"91b70808-3d15-45e0-a641-f03e2a0b0efd",
"a7f2c5e1-8d4b-4cba-9f10-2b3c4d5e6f70"
],
"associated_invited_sso_users": [],
"access_scope": {
"access_level": 3,
"categories": [],
"project_versions": [],
"languages": []
}
},
{
"reader_group_id": "b2c3d4e5-f6a7-4b8c-9d0e-a1b2c3d4e5f6",
"title": "Beta Testers",
"description": "Readers participating in the beta documentation program.",
"associated_readers": [
"e5f6a7b8-c9d0-4e1f-a2b3-c4d5e6f7a8b9"
],
"associated_invited_sso_users": [],
"access_scope": {
"access_level": 2,
"categories": [],
"project_versions": [
"46f48bc7-760f-4b07-b2d2-fce4aa8ba234"
],
"languages": []
}
}
],
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}Empty result — the project has no reader groups yet. result is an empty array.
{
"result": [],
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}Generic Customer API response envelope — a Document360.Core.Messages.Core.CustomerApiBaseResponse with a typed
Document360.Core.Messages.Common.CustomerApiResponse1.Result payload. Used when the success-shape is a single strongly-typed value (an entity, list, count, etc.). Always check Document360.Core.Messages.Core.CustomerApiBaseResponse.success before consuming Document360.Core.Messages.Common.CustomerApiResponse1.Result.
The operation's payload. Populated when Document360.Core.Messages.Core.CustomerApiBaseResponse.success is true.
V2 reader-group payload — group identity, associated readers (by ID), pending SSO invitations, and the access scope (which workspaces, languages, and categories its members can read).
The ID of the reader group.
The name of the reader group.
Description of the reader group.
List of reader IDs to be associated with this reader group.
List of reader invitation IDs. Applicable only for SSO readers.
Access scope of this reader group.
The access level of the reader group. 0-None, 1-Category, 2-Version, 3-Project, 4-Language
List of category scope objects.
Category-scoped access entry — identifies a (category, workspace, language) tuple. Used inside V2 reader and reader-group access scopes.
The category ID to which the user should be given access.
The project version ID to which the category belongs.
The language to which the user should be given access.
List of project version IDs the reader has access to.
List of language scope objects.
Pair of (workspace, language) used to scope reader/group access — describes which language inside which workspace the entity should be granted access to.
The project version ID to which the user should be given access.
The language to which the user should be given access.
Extension data for customer API response
Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.
A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.
One structured error in a response's Document360.Core.Messages.Core.BaseResponse.errors array.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.
One non-fatal warning attached to an otherwise-successful response.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.
One informational message in a response's Document360.Core.Messages.Core.BaseResponse.information array. Non-error context the SPA may surface to the user.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.
Authentication failed — the api_token header is missing, malformed, or has been revoked.
Extension data for customer API response
Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.
A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.
One structured error in a response's Document360.Core.Messages.Core.BaseResponse.errors array.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.
One non-fatal warning attached to an otherwise-successful response.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.
One informational message in a response's Document360.Core.Messages.Core.BaseResponse.information array. Non-error context the SPA may surface to the user.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.
Rate limit exceeded for this api_token. Wait for the duration in the Retry-After header before retrying.
Extension data for customer API response
Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.
A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.
One structured error in a response's Document360.Core.Messages.Core.BaseResponse.errors array.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.
One non-fatal warning attached to an otherwise-successful response.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.
One informational message in a response's Document360.Core.Messages.Core.BaseResponse.information array. Non-error context the SPA may surface to the user.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.