---
title: "List requests"
method: GET
path: "/public/one-shot/requests"
tags: ["GVRN OneShot API"]
---

# List requests

`GET /public/one-shot/requests`

## Request

- Base URL: `https://docs.gvrn.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://docs.gvrn.ai/public/one-shot/requests`
- Auth: API key in header `x-gvrn-public-api-key`

Every request this key's owner raised, newest first. Narrow it to one company with `incorporationId`, or to what is still outstanding with `status`.

## Query parameters

- `limit` number
- `offset` number
- `orderBy` 'created_at' | 'updated_at'
- `direction` 'asc' | 'desc'
- `incorporationId` string
- `kind` 'DOCUMENT' | 'COMPANY_DETAILS' | 'MEMBER_CHANGE' | 'SHARE_CAPITAL' | 'GOVERNANCE' | 'COMPLIANCE_FILING' | 'TAX' | 'ENTITY_CHANGE' | 'OTHER'
- `status` 'OPEN' | 'IN_PROGRESS' | 'RESOLVED' | 'CANCELLED'

## Response `200`

- OneShotRequestListApiResponseDto
  - `result` OneShotRequestApiResponseDto[], required
    - `id` string, required: The handle for reading or withdrawing it
    - `incorporationId` string, required
    - `companyId` string: The company the request is about
    - `kind` 'DOCUMENT' | 'COMPANY_DETAILS' | 'MEMBER_CHANGE' | 'SHARE_CAPITAL' | 'GOVERNANCE' | 'COMPLIANCE_FILING' | 'TAX' | 'ENTITY_CHANGE' | 'OTHER', required
    - `status` 'OPEN' | 'IN_PROGRESS' | 'RESOLVED' | 'CANCELLED', required: Derived from the CRM ticket behind the request
    - `subject` string, required
    - `details` string
    - `payload` object, required: Exactly what was sent, never what an operator has since edited
    - `attachmentCount` number, required: Files stored against the request's ticket
    - `createdAt` string, required: ISO 8601
    - `updatedAt` string, required: ISO 8601
    - `statusChangedAt` string, required: When the ticket last moved; for a RESOLVED request, when it closed
    - `cancelledAt` string: Set when the partner withdrew the request
  - `total` number, required: Matching the filters, not on this page
  - `limit` number, required
  - `offset` number, required

## Other responses

- `404`: No such incorporation for this key

---

[API](https://skmtc.dev/gvrn/apis/gvrn-oneshot-api.md) · [All operations](https://skmtc.dev/gvrn/apis/gvrn-oneshot-api/llms.txt) · [OpenAPI document](https://skmtc.dev/gvrn/apis/gvrn-oneshot-api/revisions/31a2ef047b90?raw)