Get settings

Get the project configuration. The plan’s retention, Slack events, PR comments. Configuration only - never a key, token or webhook. Cheap.

GET/api/v1/projects/{projectId}/settings

Parameters

Parameter	Description
`projectId`string · pathrequired	A project id from GET /projects.

Request

BASE="https://app.squally.dev/api/v1"
URL="$BASE/projects/$PROJECT/settings"
curl "$URL" \
  -H "Authorization: Bearer $SQUALLY_API_KEY"

const base = "https://app.squally.dev/api/v1";
const key = process.env.SQUALLY_API_KEY;
const url = `${base}/projects/${projectId}`
  + `/settings`;
const response = await fetch(url, {
  headers: { Authorization: `Bearer ${key}` },
});
const data = await response.json();

import os
import requests

base = "https://app.squally.dev/api/v1"
key = os.environ["SQUALLY_API_KEY"]
url = f"{base}/projects/{project_id}/settings"
response = requests.get(
    url,
    headers={"Authorization": f"Bearer {key}"},
)
data = response.json()

{
  "project": {
    "id": "3f7c2a91-5b8e-4d0a-9c61-2e4b7f0d8a…",
    "name": "storefront-web"
  },
  "settings": {
    "retentionDays": 60,
    "slack": {
      "configured": true,
      "events": [
        "run_summary"
      ]
    },
    "github": {
      "prCommentsEnabled": true
    }
  }
}

{
  "error": "Invalid read key.",
  "code": "invalid_key"
}

{
  "error": "This organization has been delete…",
  "code": "organization_deleted"
}

{
  "error": "No project with this id in this o…",
  "code": "project_not_found"
}

{
  "error": "Too many requests with this read …",
  "code": "rate_limited"
}

{
  "error": "Something went wrong on our side.",
  "code": "internal_error"
}

Example values. The shape is generated from the API schema.

Ask about this pageChatGPT Claude

Responses

200401403404429500

Read API

API reference

Get settings

Parameters

Responses