Get an organization's saved routes

GET

/route/routes

const url = 'https://api.cedr.dev/v1/route/routes?org=example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.cedr.dev/v1/route/routes?org=example' \
  --header 'Authorization: Bearer <token>'

What cedr route sync pulls: the routes.toml generated from the organization’s saved choices and the current recommendations, so a new recommendation arrives without saving again. It never contains plan readers or sync settings; those stay in each machine’s own file. Saving routes needs Pro or higher.

Authorizations

apiKey

Parameters

Query Parameters

org

required

string

The organization ID (org- and 12 hex digits), shown on Settings.

Responses

200

The organization’s routes.

application/json

object

org

required

string

routes

required

The routes.toml text.

string

rules

required

First 7 hex characters of SHA-256 over the text

string

updatedAt

required

string format: date-time

updatedBy

required

Who saved the choices last.

string | null

Example

{
  "org": "northwind",
  "routes": "version = 1\n...",
  "rules": "8ff065e",
  "updatedAt": "2026-10-29T07:00:00.000Z",
  "updatedBy": "Sam Rivera"
}

400

The request is malformed (bad_request); the message says what to send.

application/json

object

error

required

A stable code to branch on.

string

Allowed values: missing_api_key invalid_api_key ip_not_allowed insufficient_scope rate_limited not_found internal_error

message

required

A readable explanation. Its wording may change.

string

Example

{
  "error": "bad_request",
  "message": "Name the organization: ?org=<organization ID>."
}

401

The key is missing (missing_api_key) or invalid, expired or revoked (invalid_api_key). The WWW-Authenticate header names the Bearer scheme.

application/json

object

error

required

A stable code to branch on.

string

Allowed values: missing_api_key invalid_api_key ip_not_allowed insufficient_scope rate_limited not_found internal_error

message

required

A readable explanation. Its wording may change.

string

Example

{
  "error": "invalid_api_key",
  "message": "The key is invalid, expired or revoked."
}

Headers

WWW-Authenticate

string

Example

Bearer realm="cedr.dev"

403

You are not a member of that organization (not_a_member), or its plan does not include saved routes (plan_required). The CLI removes any copy it pulled earlier.

application/json

object

error

required

A stable code to branch on.

string

Allowed values: missing_api_key invalid_api_key ip_not_allowed insufficient_scope rate_limited not_found internal_error

message

required

A readable explanation. Its wording may change.

string

Example

{
  "error": "missing_api_key"
}

404

The organization has no saved routes (no_routes).

application/json

object

error

required

A stable code to branch on.

string

Allowed values: missing_api_key invalid_api_key ip_not_allowed insufficient_scope rate_limited not_found internal_error

message

required

A readable explanation. Its wording may change.

string

Example

{
  "error": "missing_api_key"
}

429

The key sent more requests in a minute than its owner’s plan allows (rate_limited): 30 on Free, 120 on Pro, 300 on Team and 600 on Business.

application/json

object

error

required

A stable code to branch on.

string

Allowed values: missing_api_key invalid_api_key ip_not_allowed insufficient_scope rate_limited not_found internal_error

message

required

A readable explanation. Its wording may change.

string

Example

{
  "error": "rate_limited",
  "message": "This key is over its plan's requests-a-minute limit."
}

Headers

Retry-After

integer

Seconds to wait before retrying.

Example

500

Something failed on our side (internal_error). Retry with backoff.

application/json

object

error

required

A stable code to branch on.

string

Allowed values: missing_api_key invalid_api_key ip_not_allowed insufficient_scope rate_limited not_found internal_error

message

required

A readable explanation. Its wording may change.

string

Example

{
  "error": "internal_error",
  "message": "Something went wrong on our side. Try again."
}