API Reference

Guardhouse external API documentation for System API clients.

Scope

This section documents the external endpoints intended for programmatic access by API clients.

Structure

• Getting Access Credentials
• Configure System API Client
• Use Credentials Programmatically
• Endpoints Overview
• Users
• Roles
• Permissions

Current Status

This first pass creates the API documentation infrastructure only:

• Navigation and grouping in the sidebar
• A dedicated access-credentials section
• A separate dashboard setup manual
• A separate programmatic usage guide
• Endpoint groups for Users, Roles, and Permissions
• One placeholder page per external endpoint folder

The next pass can fill concrete HTTP methods, routes, request models, response models, auth rules, and examples directly from the endpoint implementation folders.

Snippet Strategy

Each endpoint page is prepared for:

• Raw HTTP and curl examples
• .NET SDK examples
• Python SDK examples

Until the SDK surface is finalized, the SDK sections intentionally contain placeholder snippets.