API Overview

The AccessIQ REST API provides programmatic access to all platform features. Build integrations, automate workflows, and manage your identity infrastructure.

Base URL

API Base URLbash

https://api.accessiq.io/v1

All API endpoints are relative to this base URL. Always use HTTPS.

Key Features

RESTful Design

Predictable, resource-oriented URLs with standard HTTP methods

Secure by Default

TLS 1.3 encryption, API key authentication, rate limiting

Global Availability

99.99% uptime SLA with multi-region deployment

Developer Friendly

Comprehensive docs, SDKs, and sandbox environment

Quick Start

Make Your First API Callbash

# List users in your organization
curl https://api.accessiq.io/v1/organizations/YOUR_ORG/users \
  -H "Authorization: Bearer YOUR_API_KEY"

# Response
{
  "data": [
    {
      "id": "user_abc123",
      "email": "john@acme.com",
      "firstName": "John",
      "lastName": "Doe",
      "status": "active",
      "createdAt": "2024-01-15T10:00:00Z"
    }
  ],
  "pagination": {
    "total": 523,
    "page": 1,
    "limit": 20,
    "hasMore": true
  }
}

HTTP Methods

Method	Usage
`GET`	Retrieve resources
`POST`	Create new resources
`PUT`	Replace resources entirely
`PATCH`	Partial updates to resources
`DELETE`	Remove resources

Response Format

All responses are returned as JSON with consistent structure:

Success Responsejson

{
  "data": { ... },           // Resource or array of resources
  "pagination": {            // For list endpoints
    "total": 100,
    "page": 1,
    "limit": 20,
    "hasMore": true
  },
  "meta": {                  // Optional metadata
    "requestId": "req_abc123"
  }
}

Error Responsejson

{
  "error": {
    "code": "validation_error",
    "message": "Email is required",
    "details": [
      {
        "field": "email",
        "message": "This field is required"
      }
    ]
  },
  "meta": {
    "requestId": "req_abc123"
  }
}

Status Codes

Code	Meaning
`200`	Success
`201`	Created - Resource successfully created
`204`	No Content - Successful deletion
`400`	Bad Request - Invalid parameters
`401`	Unauthorized - Invalid or missing API key
`403`	Forbidden - Insufficient permissions
`404`	Not Found - Resource doesn't exist
`429`	Rate Limited - Too many requests
`500`	Server Error - Something went wrong

Pagination

List endpoints support cursor-based pagination:

Paginated Requestbash

# First page
curl "https://api.accessiq.io/v1/organizations/YOUR_ORG/users?limit=20"

# Next page
curl "https://api.accessiq.io/v1/organizations/YOUR_ORG/users?limit=20&after=user_abc123"

Rate Limiting

API requests are rate limited based on your plan:

Plan	Rate Limit
Free	100 requests/minute
Professional	1,000 requests/minute
Enterprise	10,000 requests/minute

Rate limit headers are included in all responses:

Rate Limit Headerstext

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 995
X-RateLimit-Reset: 1705320000

Need Higher Limits?

Contact our sales team to discuss custom rate limits for high-volume use cases.