Platform API (/v1)
Endpoints
This page lists every endpoint of the /api/v1 surface, 58 in total. It is generated from the platform's route tree each time this site is built. A production release builds it from the same commit as the app, so it describes the routes that release serves.
Each endpoint shows the role its caller must hold, the minimum token scope, the query parameters it accepts, its rate limit and its known errors. The known-errors list is a minimum, not an exhaustive list. It is derived from the authentication layer and the handler code the generator can read, so an endpoint can return codes it does not show. Some of the codes it does show apply only in certain configurations. IP_BLOCKED needs an IP allowlist, for example, and the PAT_* codes apply only to token callers. Handle what you might receive, not only what you expect.
Versioning. Within /v1 the platform may ADD response fields and ADD optional request parameters. It does not remove or retype an existing field, and does not remove an operation, inside a version. A breaking change takes a new prefix.
| |
|---|
| Access | The credential itself. A data-room-restricted token is admitted here. |
| Required role | No role requirement of its own. The endpoint may still refuse (see Known errors) |
| Token scope | read or higher |
| Query parameters | None accepted. Any query parameter is rejected with 400. |
| Rate limit | 60 requests per minute per identity |
| Known errors | IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, ORGANIZATION_REQUIRED, PAT_PATH_MALFORMED 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | Deal team: organization owner, admin or member |
| Token scope | read or higher |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | 60 requests per minute per identity |
| Known errors | FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, ORG_NOT_FOUND, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_ROLE_CEILING 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | Deal team: organization owner, admin or member |
| Token scope | read or higher |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | 60 requests per minute per identity |
| Known errors | FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_ROLE_CEILING 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | Organization owner or admin |
| Token scope | write or higher |
| Token permission | A personal access token needs external:send (Send to people outside your organization), or it is refused with PAT_GRANT_REQUIRED |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | 60 requests per minute per identity |
| Known errors | FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, PAT_DATAROOM_SCOPE 403, PAT_GRANT_REQUIRED 403, PAT_PATH_MALFORMED 403, PAT_ROLE_CEILING 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | Organization owner or admin |
| Token scope | write or higher |
| Token permission | A personal access token needs external:send (Send to people outside your organization) only for a change to a member whose current role is not deal team: every assignable role is, so the change promotes an outsider. Without it, that request is refused with PAT_GRANT_REQUIRED |
| Path parameters | membershipId |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | 60 requests per minute per identity |
| Known errors | FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, PAT_DATAROOM_SCOPE 403, PAT_GRANT_REQUIRED 403, PAT_PATH_MALFORMED 403, PAT_ROLE_CEILING 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | Organization owner or admin |
| Token scope | write or higher |
| Path parameters | membershipId |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | 60 requests per minute per identity |
| Known errors | FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_ROLE_CEILING 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Data room. The caller must be able to access the data room named in the request. |
| Required role | Organization owner or admin |
| Token scope | write or higher |
| Token permission | A personal access token needs external:send (Send to people outside your organization) only for a grant that reads or downloads, to a grantee outside the deal team; a deny, or a grant to the deal team, needs no grant. Without it, that request is refused with PAT_GRANT_REQUIRED |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | ACCESS_EXPIRED 403, BAD_REQUEST 400, FORBIDDEN 403, GRANTEE_NOT_FOUND, GRANTEE_NOT_IN_DATAROOM, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, NDA_REQUIRED 403, ORG_CONTEXT_STALE 409, PAT_DATAROOM_SCOPE 403, PAT_GRANT_REQUIRED 403, PAT_PATH_MALFORMED 403, PAT_ROLE_CEILING 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/404/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Data room. The caller must be able to access the data room named in the request. |
| Required role | Organization owner or admin |
| Token scope | write or higher |
| Token permission | A personal access token needs external:send (Send to people outside your organization) only for revoking a deny row of a grantee outside the deal team, which restores their access; ending a grant needs no grant. Without it, that request is refused with PAT_GRANT_REQUIRED |
| Path parameters | id |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | ACCESS_EXPIRED 403, BAD_REQUEST 400, FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, NDA_REQUIRED 403, NOT_FOUND, ORG_CONTEXT_STALE 409, PAT_DATAROOM_SCOPE 403, PAT_GRANT_REQUIRED 403, PAT_PATH_MALFORMED 403, PAT_ROLE_CEILING 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/404/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | Deal team: organization owner, admin or member |
| Token scope | read or higher |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | 60 requests per minute per identity |
| Known errors | FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_ROLE_CEILING 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | Deal team: organization owner, admin or member |
| Token scope | read or higher |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | 60 requests per minute per identity |
| Known errors | FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_ROLE_CEILING 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Data room. The caller must be able to access the data room named in the request. |
| Required role | Deal team: organization owner, admin or member |
| Token scope | read or higher |
| Token permission | A personal access token needs content:read (Read document content), or it is refused with PAT_GRANT_REQUIRED |
| Path parameters | fileId |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | ACCESS_EXPIRED 403, BAD_REQUEST 400, FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, NDA_REQUIRED 403, ORG_CONTEXT_STALE 409, PAT_DATAROOM_SCOPE 403, PAT_GRANT_REQUIRED 403, PAT_PATH_MALFORMED 403, PAT_ROLE_CEILING 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, SUBSCRIPTION_LAPSED 402, TRIAL_EXPIRED 402, UNAUTHORIZED 401/403/404/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Data room. The caller must be able to access the data room named in the request. |
| Required role | Deal team: organization owner, admin or member |
| Token scope | write or higher |
| Path parameters | fileId |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | ACCESS_EXPIRED 403, BAD_REQUEST 400, FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, NDA_REQUIRED 403, NOT_FOUND, ORG_CONTEXT_STALE 409, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_ROLE_CEILING 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/404/429/503, UPLOAD_INCOMPLETE. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Data room. The caller must be able to access the data room named in the request. |
| Required role | Deal team: organization owner, admin or member |
| Token scope | write or higher |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | ACCESS_EXPIRED 403, BAD_REQUEST 400, FILE_TOO_LARGE, FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, NDA_REQUIRED 403, NOT_FOUND, ORG_CONTEXT_STALE 409, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_ROLE_CEILING 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, SIZE_LIMIT_EXCEEDED, UNAUTHORIZED 401/403/404/429/503, UPLOAD_INCOMPLETE. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Data room. The caller must be able to access the data room named in the request. |
| Required role | Deal team: organization owner, admin or member |
| Token scope | write or higher |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | None |
| Known errors | ACCESS_EXPIRED 403, BAD_REQUEST 400, BLOCKED_FILE_TYPE, DATAROOM_REQUIRED, FILE_TOO_LARGE, FORBIDDEN 403, INTERNAL_ERROR, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, NDA_REQUIRED 403, ORG_CONTEXT_STALE 409, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_ROLE_CEILING 403, PAT_SCOPE_INSUFFICIENT 403, PAYMENT_REQUIRED, SESSION_EXPIRED 401, SUBSCRIPTION_LAPSED 402, TRIAL_EXPIRED 402, UNAUTHORIZED 401/403/404/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | Deal team: organization owner, admin or member |
| Token scope | read or higher |
| Token permission | A personal access token needs content:read (Read document content) only for returns each fact's verbatim quote; without the grant the page is served with quote dropped and value cut (fact-cut.ts). Without it, that request is refused with PAT_GRANT_REQUIRED |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, PAT_DATAROOM_SCOPE 403, PAT_GRANT_REQUIRED 403, PAT_PATH_MALFORMED 403, PAT_ROLE_CEILING 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Data room. The caller must be able to access the data room named in the request. |
| Required role | Deal team: organization owner, admin or member |
| Token scope | read or higher |
| Query parameters | dataroomId, fileId, limit, offset, status. Any other parameter is rejected with 400. |
| Rate limit | 60 requests per minute per identity |
| Known errors | ACCESS_EXPIRED 403, BAD_REQUEST 400, FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, NDA_REQUIRED 403, ORG_CONTEXT_STALE 409, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_ROLE_CEILING 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/404/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Data room. The caller must be able to access the data room named in the request. |
| Required role | Deal team: organization owner, admin or member |
| Token scope | write or higher |
| Token permission | A personal access token needs content:read (Read document content), or it is refused with PAT_GRANT_REQUIRED |
| Query parameters | None accepted. Any query parameter is rejected with 400. |
| Rate limit | 30 requests per minute per identity |
| AI budget | Draws on the organization's daily AI budget |
| Known errors | ACCESS_EXPIRED 403, AI_BUDGET_UNAVAILABLE 503, AI_DAILY_BUDGET_EXCEEDED 429, ai_disabled 403, BAD_REQUEST 400, FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, NDA_REQUIRED 403, NOT_FOUND, ORG_CONTEXT_STALE 409, PAID_PLAN_REQUIRED 402, PAT_DATAROOM_SCOPE 403, PAT_GRANT_REQUIRED 403, PAT_PATH_MALFORMED 403, PAT_ROLE_CEILING 403, PAT_SCOPE_INSUFFICIENT 403, PIPELINE_PAUSED 503, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/404/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | No role requirement of its own. The endpoint may still refuse (see Known errors) |
| Token scope | write or higher |
| Path parameters | name |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | 5 requests per minute per identity |
| AI budget | Draws on the organization's daily AI budget |
| Known errors | AI_BUDGET_UNAVAILABLE 503, AI_DAILY_BUDGET_EXCEEDED 429, ai_disabled 403, BAD_REQUEST, CONFLICT, FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, NOT_FOUND, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_SCOPE_INSUFFICIENT 403, PIPELINE_PAUSED 503, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | Deal team: organization owner, admin or member |
| Token scope | read or higher |
| Token permission | A personal access token needs analytics:read (Read engagement analytics), or it is refused with PAT_GRANT_REQUIRED |
| Query parameters | counterparty, cursor, limit, since. Any other parameter is rejected with 400. |
| Rate limit | 60 requests per minute per identity |
| Known errors | FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, PAT_DATAROOM_SCOPE 403, PAT_GRANT_REQUIRED 403, PAT_PATH_MALFORMED 403, PAT_ROLE_CEILING 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | Deal team: organization owner, admin or member |
| Token scope | read or higher |
| Token permission | A personal access token needs analytics:read (Read engagement analytics), or it is refused with PAT_GRANT_REQUIRED |
| Query parameters | counterparty, cursor, limit, weeks. Any other parameter is rejected with 400. |
| Rate limit | 60 requests per minute per identity |
| Known errors | FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, PAT_DATAROOM_SCOPE 403, PAT_GRANT_REQUIRED 403, PAT_PATH_MALFORMED 403, PAT_ROLE_CEILING 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | Deal team: organization owner, admin or member |
| Token scope | read or higher |
| Token permission | A personal access token needs analytics:read (Read engagement analytics), or it is refused with PAT_GRANT_REQUIRED |
| Query parameters | fileId, range. Any other parameter is rejected with 400. |
| Rate limit | 60 requests per minute per identity |
| Known errors | FILE_NOT_FOUND, FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, PAT_DATAROOM_SCOPE 403, PAT_GRANT_REQUIRED 403, PAT_PATH_MALFORMED 403, PAT_ROLE_CEILING 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | Deal team: organization owner, admin or member |
| Token scope | read or higher |
| Token permission | A personal access token needs analytics:read (Read engagement analytics), or it is refused with PAT_GRANT_REQUIRED |
| Query parameters | counterparty, cursor, fileId, limit, weeks. Any other parameter is rejected with 400. |
| Rate limit | 60 requests per minute per identity |
| Known errors | FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, PAT_DATAROOM_SCOPE 403, PAT_GRANT_REQUIRED 403, PAT_PATH_MALFORMED 403, PAT_ROLE_CEILING 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | Deal team: organization owner, admin or member |
| Token scope | read or higher |
| Token permission | A personal access token needs analytics:read (Read engagement analytics), or it is refused with PAT_GRANT_REQUIRED |
| Query parameters | counterparty, cursor, limit, weeks. Any other parameter is rejected with 400. |
| Rate limit | 60 requests per minute per identity |
| Known errors | FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, PAT_DATAROOM_SCOPE 403, PAT_GRANT_REQUIRED 403, PAT_PATH_MALFORMED 403, PAT_ROLE_CEILING 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
Request and response schemas for the loan-domain routes, and the ingestion contract they share, are in the loan API reference.
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | Organization owner or admin |
| Token scope | read or higher |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | ADDON_NOT_PURCHASED, FORBIDDEN 403, INVALID_BODY, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_ROLE_CEILING 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503, VALIDATION_FAILED. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | Organization owner or admin |
| Token scope | read or higher |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | 20 requests per minute per identity |
| AI budget | Draws on the organization's daily AI budget |
| Known errors | ADDON_NOT_PURCHASED, AI_BUDGET_UNAVAILABLE 503, AI_DAILY_BUDGET_EXCEEDED 429, ai_disabled 403, FORBIDDEN 403, INVALID_BODY, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_ROLE_CEILING 403, PAT_SCOPE_INSUFFICIENT 403, PIPELINE_PAUSED 503, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503, VALIDATION_FAILED. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | No role requirement of its own. The endpoint may still refuse (see Known errors) |
| Token scope | read or higher |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | No role requirement of its own. The endpoint may still refuse (see Known errors) |
| Token scope | write or higher |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503, UNKNOWN_EXPORT_TYPE. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | No role requirement of its own. The endpoint may still refuse (see Known errors) |
| Token scope | read or higher |
| Path parameters | id |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | Organization owner or admin |
| Token scope | read or higher |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_ROLE_CEILING 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | Organization owner or admin |
| Token scope | read or higher |
| Path parameters | id |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_ROLE_CEILING 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | No role requirement of its own. The endpoint may still refuse (see Known errors) |
| Token scope | write or higher |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | FORBIDDEN 403, ID_CONFLICT, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, MONITORING_INVESTOR_FORBIDDEN 403, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_SCOPE_INSUFFICIENT 403, PORTFOLIO_NOT_FOUND, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | No role requirement of its own. The endpoint may still refuse (see Known errors) |
| Token scope | read or higher |
| Path parameters | id |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, MONITORING_INVESTOR_FORBIDDEN 403, NOT_FOUND, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | No role requirement of its own. The endpoint may still refuse (see Known errors) |
| Token scope | write or higher |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, MONITORING_INVESTOR_FORBIDDEN 403, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | No role requirement of its own. The endpoint may still refuse (see Known errors) |
| Token scope | write or higher |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, MONITORING_INVESTOR_FORBIDDEN 403, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | No role requirement of its own. The endpoint may still refuse (see Known errors) |
| Token scope | write or higher |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, MONITORING_INVESTOR_FORBIDDEN 403, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | No role requirement of its own. The endpoint may still refuse (see Known errors) |
| Token scope | write or higher |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, MONITORING_INVESTOR_FORBIDDEN 403, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | No role requirement of its own. The endpoint may still refuse (see Known errors) |
| Token scope | write or higher |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, MONITORING_INVESTOR_FORBIDDEN 403, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | No role requirement of its own. The endpoint may still refuse (see Known errors) |
| Token scope | write or higher |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, MONITORING_INVESTOR_FORBIDDEN 403, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | No role requirement of its own. The endpoint may still refuse (see Known errors) |
| Token scope | write or higher |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | FORBIDDEN 403, ID_CONFLICT, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, MONITORING_INVESTOR_FORBIDDEN 403, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_SCOPE_INSUFFICIENT 403, PORTFOLIO_NOT_FOUND, RATE_LIMITED 429, REFERENCED_ENTITY_NOT_FOUND, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | No role requirement of its own. The endpoint may still refuse (see Known errors) |
| Token scope | write or higher |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | FORBIDDEN 403, ID_CONFLICT, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, MONITORING_INVESTOR_FORBIDDEN 403, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_SCOPE_INSUFFICIENT 403, PORTFOLIO_NOT_FOUND, RATE_LIMITED 429, REFERENCED_ENTITY_NOT_FOUND, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | No role requirement of its own. The endpoint may still refuse (see Known errors) |
| Token scope | read or higher |
| Path parameters | id |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, MONITORING_INVESTOR_FORBIDDEN 403, NOT_FOUND, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | No role requirement of its own. The endpoint may still refuse (see Known errors) |
| Token scope | read or higher |
| Path parameters | id |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, MONITORING_INVESTOR_FORBIDDEN 403, NOT_FOUND, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | No role requirement of its own. The endpoint may still refuse (see Known errors) |
| Token scope | read or higher |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, MONITORING_INVESTOR_FORBIDDEN 403, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | No role requirement of its own. The endpoint may still refuse (see Known errors) |
| Token scope | read or higher |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, MONITORING_INVESTOR_FORBIDDEN 403, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | No role requirement of its own. The endpoint may still refuse (see Known errors) |
| Token scope | write or higher |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | FORBIDDEN 403, IDEMPOTENCY_KEY_REUSED, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, MONITORING_INVESTOR_FORBIDDEN 403, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503, UNKNOWN_KIND. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | No role requirement of its own. The endpoint may still refuse (see Known errors) |
| Token scope | read or higher |
| Path parameters | id |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, MONITORING_INVESTOR_FORBIDDEN 403, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | No role requirement of its own. The endpoint may still refuse (see Known errors) |
| Token scope | write or higher |
| Path parameters | id |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, MONITORING_INVESTOR_FORBIDDEN 403, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | No role requirement of its own. The endpoint may still refuse (see Known errors) |
| Token scope | write or higher |
| Path parameters | id |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | COMMIT_FAILED, FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, MONITORING_INVESTOR_FORBIDDEN 403, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | No role requirement of its own. The endpoint may still refuse (see Known errors) |
| Token scope | read or higher |
| Path parameters | id |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, MONITORING_INVESTOR_FORBIDDEN 403, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | No role requirement of its own. The endpoint may still refuse (see Known errors) |
| Token scope | write or higher |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | FORBIDDEN 403, ID_CONFLICT, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, MONITORING_INVESTOR_FORBIDDEN 403, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_SCOPE_INSUFFICIENT 403, PORTFOLIO_NOT_FOUND, RATE_LIMITED 429, REFERENCED_ENTITY_NOT_FOUND, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | No role requirement of its own. The endpoint may still refuse (see Known errors) |
| Token scope | read or higher |
| Path parameters | externalId |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, MONITORING_INVESTOR_FORBIDDEN 403, NOT_FOUND, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | No role requirement of its own. The endpoint may still refuse (see Known errors) |
| Token scope | write or higher |
| Path parameters | externalId |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | FORBIDDEN 403, IDEMPOTENCY_CONFLICT, INVALID_STATUS_TRANSITION, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, MONITORING_INVESTOR_FORBIDDEN 403, NOT_FOUND, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | No role requirement of its own. The endpoint may still refuse (see Known errors) |
| Token scope | write or higher |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | CHECK_VIOLATION, FORBIDDEN 403, ID_CONFLICT, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, MONITORING_INVESTOR_FORBIDDEN 403, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_SCOPE_INSUFFICIENT 403, PORTFOLIO_NOT_FOUND, RATE_LIMITED 429, REFERENCED_ENTITY_NOT_FOUND, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | No role requirement of its own. The endpoint may still refuse (see Known errors) |
| Token scope | read or higher |
| Path parameters | id |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, MONITORING_INVESTOR_FORBIDDEN 403, NOT_FOUND, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | No role requirement of its own. The endpoint may still refuse (see Known errors) |
| Token scope | write or higher |
| Path parameters | id |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, MONITORING_INVESTOR_FORBIDDEN 403, NOT_FOUND, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | No role requirement of its own. The endpoint may still refuse (see Known errors) |
| Token scope | write or higher |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | FORBIDDEN 403, ID_CONFLICT, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, MONITORING_INVESTOR_FORBIDDEN 403, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_SCOPE_INSUFFICIENT 403, PORTFOLIO_NOT_FOUND, RATE_LIMITED 429, REFERENCED_ENTITY_NOT_FOUND, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | No role requirement of its own. The endpoint may still refuse (see Known errors) |
| Token scope | read or higher |
| Path parameters | id |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, MONITORING_INVESTOR_FORBIDDEN 403, NOT_FOUND, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503. A known minimum, not exhaustive. See error codes. |
| |
|---|
| Access | Organization. Answers for the organization the credential belongs to. |
| Required role | No role requirement of its own. The endpoint may still refuse (see Known errors) |
| Token scope | read or higher |
| Query parameters | Not validated against a fixed list. Send only the parameters you intend. |
| Rate limit | The platform-wide default |
| Known errors | FORBIDDEN 403, IP_BLOCKED 403, MFA_CHALLENGE_REQUIRED 403, MFA_SETUP_REQUIRED 403, MONITORING_INVESTOR_FORBIDDEN 403, PAT_DATAROOM_SCOPE 403, PAT_PATH_MALFORMED 403, PAT_SCOPE_INSUFFICIENT 403, RATE_LIMITED 429, SESSION_EXPIRED 401, UNAUTHORIZED 401/403/429/503, VALIDATION_ERROR. A known minimum, not exhaustive. See error codes. |