Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.traversal.com/llms.txt

Use this file to discover all available pages before exploring further.

The Traversal API lets you integrate investigations into your own tools, pipelines, and workflows. Anything a member can do in the Traversal web app, you can do over the API. To get started, create an API key and make your first request.

​
Base URL

All endpoints are served from: 
https://api.traversal.com
BYOC customers use the API endpoint exposed by their dedicated deployment instead — see Bring Your Own Cloud for details.

​
Error format

All errors follow a consistent envelope: 
{
  "error": {
    "message": "A human-readable explanation of the error.",
    "retry_after": 30
  }
}
FieldTypeDescription
error.messagestringHuman-readable explanation of the error.
error.retry_afterinteger | nullSuggested seconds to wait before retrying. Present on 429 and 409 responses.
When retry_after is present in the body, the response also includes a standard Retry-After HTTP header with the same value.

​
Status codes

Status codeMeaningWhen it occurs
400Bad RequestInvalid or missing fields in the request body. The message indicates which field failed validation.
401UnauthorizedMissing, invalid, or revoked API key.
403ForbiddenAPI not enabled for the organization, or the authenticated user has insufficient role.
500Internal Server ErrorAn unexpected error occurred on the server.
503Service UnavailableAPI infrastructure is not available.
Individual endpoints may define additional status codes specific to their behavior — see the relevant API reference page for details.