Making your first request

This article guides you through sending your first authenticated v3 API request using one of the following methods.

Base URL and authentication

Authenticate every request by sending your API key in the X-API-Key header:

X-API-Key: YOUR_API_KEY

You will use this API key regardless of the tool — in curl as a request header, in Postman as a header on the Headers tab, and in the interactive reference through the Authorize button.

Option 1: Using the interactive API reference

The interactive reference provides a browser-based interface to try every endpoint in real time.

1. Open the v3 API reference.
2. Click Authorize.
3. Provide your API key and click Authorize.
4. Navigate to any endpoint, enter the required values, and click Execute.
5. View the response directly in the browser.

Option 2: Using Postman

Postman lets you import the Document360 v3 API collection and make requests from a graphical interface. This is recommended for testing and team collaboration.

1. Log in to Postman and click Import.
2. Choose the Link option and paste the v3 OpenAPI URL: https://apihub.document360.io/swagger/v3/swagger.json
3. Click Continue, then Import.
4. Set the base URL, then add a header named X-API-Key with your API key on the Headers tab.
5. Send a request to any available endpoint.

Option 3: Using curl

A good first request is to list the projects your API key can access — this also returns the project_id you need for most other calls.

curl --request GET "https://apihub.document360.io/v3/projects" \
  --header "X-API-Key: YOUR_API_KEY"

A successful response returns a paginated list of projects:

{
  "success": true,
  "request_id": "req_abc123def456",
  "data": [
    {
      "id": "1c2d3e4f-5a6b-7c8d-9e0f-a1b2c3d4e5f6",
      "name": "Product Docs",
      "description": "Customer-facing product documentation",
      "sub_domain_name": "docs",
      "status": 0,
      "created_at": "2025-01-15T09:00:00Z",
      "modified_at": "2026-06-30T12:00:00Z"
    }
  ],
  "pagination": { "page": 1, "page_size": 25, "total_count": 1, "has_more": false }
}

What's next?

• Create and publish an article
• Add a team account or a reader
• Explore the full API reference