Skip to content
API Reference

Complete API Documentation

Everything you need to integrate APIDock into your workflow. Comprehensive endpoints, detailed parameters, and ready-to-use code examples.

REST API GraphQL Webhooks SDKs

Base URL

https://api.apidock.com/v1

All API requests should be made to this base URL. Include your API key in the Authorization header.

Authentication

APIDock uses API keys to authenticate requests. You can view and manage your API keys in the Dashboard.

Include your API key in the Authorization header of every request.

  • API keys are project-scoped
  • Keys can be revoked at any time
  • Supports read-only and read-write permissions

# Example request

curl -X GET "https://api.apidock.com/v1/projects" \
  -H "Authorization: Bearer YOUR_API_KEY"

Endpoints

Core API endpoints for managing your documentation

Projects

GET /projects

Retrieve a list of all projects in your account.

View details

Query Parameters

Parameter Type Description
pageintegerPage number (default: 1)
limitintegerItems per page (default: 20, max: 100)
statusstringFilter by status: active, archived

Response

{
  "data": [
    {
      "id": "proj_abc123",
      "name": "My API",
      "slug": "my-api",
      "created_at": "2024-01-15T10:30:00Z"
    }
  ],
  "meta": {
    "total": 1,
    "page": 1,
    "limit": 20
  }
}
POST /projects

Create a new documentation project.

View details

Request Body

{
  "name": "My New API",
  "description": "API documentation for my project",
  "visibility": "public",
  "template": "default"
}

Response (201 Created)

{
  "id": "proj_xyz789",
  "name": "My New API",
  "slug": "my-new-api",
  "url": "https://docs.example.com/my-new-api",
  "created_at": "2024-12-20T14:22:00Z"
}
GET /projects/{id}

Retrieve details for a specific project.

PATCH /projects/{id}

Update an existing project's settings.

DELETE /projects/{id}

Delete a project and all its documentation.

Documents

GET /projects/{id}/documents

List all documents in a project.

POST /projects/{id}/documents

Create a new document or endpoint reference.

PUT /projects/{id}/documents/{doc_id}

Update a document's content and metadata.

Versions

GET /projects/{id}/versions

List all versions of a project's documentation.

POST /projects/{id}/versions

Create a new version snapshot.

Error Codes

APIDock uses conventional HTTP response codes to indicate success or failure.

Code Status Description
200 OK Request succeeded
201 Created Resource created successfully
400 Bad Request Invalid request parameters
401 Unauthorized Invalid or missing API key
403 Forbidden Insufficient permissions
404 Not Found Resource not found
429 Too Many Requests Rate limit exceeded
500 Internal Error Server error - please contact support

Rate Limits

1,000
Free Plan
requests per hour
10,000
Pro Plan
requests per hour
Unlimited
Enterprise
custom limits available

Rate limit headers are included in every response: X-RateLimit-Remaining

Ready to Build?

Try our interactive playground to test API calls in real-time.

Open Playground Download SDKs