API introduction

Base URL

https://api.alignr.io/api/v1

The REST API uses JSON and bearer authentication. Start with a key granting organization.read.

List your Organizations

Store your API key in the ALIGNR_API_KEY environment variable through your secret manager or shell environment, then run:

curl --fail-with-body \
  'https://api.alignr.io/api/v1/organizations?page=1&pageSize=20' \
  --header "Authorization: Bearer $ALIGNR_API_KEY"

The response contains an items array and pagination metadata. Use an Organization’s id in requests that require a client identifier. An empty items array can be a valid result; it does not prove the workspace is fully configured.

Next steps

Authentication

Understand API keys and permissions.

Live API schema

Retrieve the reference for your running deployment.

⌘I

Overview

Reference

Organizations

Standards

Alignment

Detections

Evidence

API introduction

Base URL

List your Organizations

Next steps

Authentication

Live API schema

​Base URL

​List your Organizations

​Next steps

Authentication

Live API schema

Base URL

List your Organizations

Next steps