Company logoTrust Center Documentation
API v1 ReferenceAccess requests

List all access requests

Retrieve all access requests for your tenant with detailed contact and document information. Results are sorted by creation date (newest first) and can be filtered by review status and account.

GET
/api/v1/access-requests

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

review_status?array<>

Filter by one or more review status values. Can be specified multiple times for multiple statuses.

account_id?string

Filter access requests by specific account ID

Formatuuid
search?string

Search by contact name, email, or account title

page?integer

Page number for paginated results (1-indexed)

Range1 <= value
limit?integer

Number of access requests per page when paginating

Range1 <= value

Response Body

application/json

application/json

curl -X GET "https://app.orbiqhq.com/api/v1/access-requests?review_status=to_review&review_status=in_review&account_id=550e8400-e29b-41d4-a716-446655440000&search=acme&page=1&limit=20"
{
  "access_requests": [
    {
      "id": "req-123",
      "review_status": "to_review",
      "date_created": "2025-01-15T10:00:00Z",
      "date_updated": "2025-01-15T10:00:00Z",
      "contact": {
        "id": "contact-1",
        "first_name": "John",
        "last_name": "Doe",
        "email": "john.doe@acme.com",
        "review_status": "to_review",
        "account": {
          "id": "acc-123",
          "title": "Acme Corporation",
          "review_status": "approved"
        }
      },
      "documents": [
        {
          "documents_id": {
            "id": "doc-1",
            "title": "SOC 2 Type II Report",
            "description": "Annual security audit report",
            "access_level": "restricted"
          }
        },
        {
          "documents_id": {
            "id": "doc-2",
            "title": "ISO 27001 Certificate",
            "description": "Information security certification",
            "access_level": "public"
          }
        }
      ]
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 64,
    "page_count": 4
  }
}
Empty
{
  "error": "Failed to load access requests"
}

How is this guide?