Using the API

Errors and Troubleshooting

Common API error patterns and how to resolve them.

Error Format

Most endpoints return structured error payloads with a status code and message.

Common Cases

  • 401 or 403: invalid credentials or insufficient permissions.
  • 404: resource was not found.
  • 422: request validation failed.
  • 500: unexpected server error.

Debug Checklist

  1. Verify credentials and request headers.
  2. Validate request body fields and data types.
  3. Confirm the target resource exists and is accessible.

How is this guide?

Webhooks

Receive event-driven updates from the Onboard platform.

AI assistant rules

Copy, download, or bundle Onboard integration rules for Cursor, Claude, and Windsurf.

On this page

Error FormatCommon CasesDebug Checklist