GVRN OneShot API

List requests

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

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

Query parameters

limitnumber
Example:20

Page size. Defaults to 20, capped at 100.

offsetnumber

How many to skip; newest first by default

orderBy'created_at' | 'updated_at'
Example:created_at

Order by field: created_at, updated_at

direction'asc' | 'desc'
Example:desc
incorporationIdstring

Only requests raised against this incorporation

kind'DOCUMENT' | 'COMPANY_DETAILS' | 'MEMBER_CHANGE' | 'SHARE_CAPITAL' | 'GOVERNANCE' | 'COMPLIANCE_FILING' | 'TAX' | 'ENTITY_CHANGE' | 'OTHER'
status'OPEN' | 'IN_PROGRESS' | 'RESOLVED' | 'CANCELLED'
Example:OPEN

Response

totalnumber required

Matching the filters, not on this page

limitnumber required
offsetnumber required

Example response

{
  "result": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "incorporationId": "123e4567-e89b-12d3-a456-426614174000",
      "companyId": "123e4567-e89b-12d3-a456-426614174000",
      "subject": "Certified copy of the certificate for HSBC",
      "details": "The bank wants a certified copy dated within three months.",
      "createdAt": "2026-09-02T09:12:44.000Z",
      "updatedAt": "2026-09-02T09:12:44.000Z",
      "statusChangedAt": "2026-09-02T09:12:44.000Z"
    }
  ],
  "total": 2,
  "limit": 20
}

Changes

No recorded changes to this operation across all 1 revision of this API.