Developers › API reference › Access reviews

GET `/api/v1/access-reviews/{id}`

One access review with its recommendations.

Scope access_reviews:read
operationId adminReview

The token needs the scope access_reviews:read, and the person or service account behind it needs the matching privileges and account permissions, exactly as on the screens. See Scopes.

Request

GET /api/v1/access-reviews/{id}

Path parameters

Name	Description	Example
`id`	The id of the access review.	`1`

Headers

Header	Required	Value
`Authorization`	yes	`Bearer <token>`: an OAuth access token (`vat_…`) or a personal access token (`vpt_…`). Get a token

Examples

Keep the token in an environment variable (VESTORIS_TOKEN), never in the script.

curl

curl "https://vestoris.com/api/v1/access-reviews/1" \
  -H "Authorization: Bearer $VESTORIS_TOKEN"

Python (requests)

import os, requests

r = requests.get(
    "https://vestoris.com/api/v1/access-reviews/1",
    headers={
        "Authorization": f"Bearer {os.environ['VESTORIS_TOKEN']}",
    },
    timeout=30,
)
r.raise_for_status()  # errors are application/problem+json with a stable "code"
print(r.json())

JavaScript (fetch)

const res = await fetch("https://vestoris.com/api/v1/access-reviews/1", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.VESTORIS_TOKEN}`,
  },
});
const data = await res.json();
if (!res.ok) throw new Error(`${data.code}: ${data.detail}`); // problem+json
console.log(data);

Response

200 OK, application/json: AccessReview. Rate-limit headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.

Response fields

Field	Type	Description
`id`	id (string)	The record's id (a string of digits).
`period`	string	The period reviewed.
`status`	string	draft or signed.
`drafted_by_ai`	boolean	True when the AI drafted it (a person still checks and signs).
`draft`	string	The drafted text.
`recommendations`	list	What the review recommends (grant, revoke, adjust), each with a reason.
`created_at`	date-time or null	When it was created.
`signed_by`	id (string) or null	Who signed off.
`signed_at`	date-time or null	When it was signed off.
`sign_note`	string or null	The note written at sign-off.

Example response

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": "1042",
    "period": "2026-Q3",
    "status": "draft",
    "drafted_by_ai": false,
    "draft": "",
    "recommendations": [],
    "created_at": "2026-10-27T14:30:00Z",
    "signed_by": null,
    "signed_at": null,
    "sign_note": null
}

Example values. Your values depend on your firm's data; prices, orders and fills are simulated.

Status codes and errors

Errors are application/problem+json (RFC 9457) with a stable code to program against; the detail says what to fix. See Errors.

Status	When	Problem codes
200	Success
400	The request is malformed	`invalid_request`
401	No token, or it is invalid or expired	`invalid_token`
403	The token lacks the scope, or the person or service account behind it lacks the privilege or account permission	`insufficient_scope` `forbidden` `ip_not_allowed`
404	Not found, or not visible to you (the API never confirms what you may not see)	`not_found`
429	Rate limited: wait for Retry-After seconds	`rate_limited`

{
    "type": "https://vestoris.com/developers/errors#validation_failed",
    "title": "Validation failed",
    "status": 422,
    "detail": "Quantity must be greater than zero.",
    "code": "validation_failed",
    "instance": "/api/v1/access-reviews/1"
}

On the screens

The same thing in the app is explained in:

Access reviews