Get the project configuration

GET

/projects/{projectId}/settings

curl --request GET \
  --url https://app.squally.dev/api/v1/projects/example/settings \
  --header 'Authorization: Bearer <token>'

Stable branch, the plan’s retention, Slack events, PR comments. Configuration only - never a key, token or webhook. Cheap.

Authorizations

• readKey

Parameters

Path Parameters

projectId

required

string

A project id from GET /projects.

Responses

200

OK

Media typeapplication/json

object

project

required

object

id

required

string

name

required

string

settings

required

object

stableBranch

required

string

retentionDays

required

integer

>= -9007199254740991 <= 9007199254740991

slack

required

object

configured

required

boolean

events

required

Array<string>

github

required

object

prCommentsEnabled

required

boolean

Example^generated

{
  "project": {
    "id": "example",
    "name": "example"
  },
  "settings": {
    "stableBranch": "example",
    "retentionDays": 1,
    "slack": {
      "configured": true,
      "events": [
        "example"
      ]
    },
    "github": {
      "prCommentsEnabled": true
    }
  }
}

Headers

Squally-Key-Expires-At

string format: date-time

When the read key expires (ISO-8601). Present only from 7 days before expiry.

401

Error: invalid_key, key_expired, key_revoked, missing_key, wrong_key_type

Media typeapplication/json

object

error

required

A sentence for a human. May be reworded.

string

code

required

Stable slug - match on this, not on the sentence.

string

Allowed values: missing_key invalid_key wrong_key_type key_revoked key_expired tier_too_low project_not_found invalid_period rate_limited test_not_found ambiguous_test internal_error invalid_parameter run_not_found error_not_found

code

required

Allowed values: invalid_key key_expired key_revoked missing_key wrong_key_type

Example

{
  "code": "invalid_key"
}

403

Error: tier_too_low

Media typeapplication/json

object

error

required

A sentence for a human. May be reworded.

string

code

required

Stable slug - match on this, not on the sentence.

string

Allowed values: missing_key invalid_key wrong_key_type key_revoked key_expired tier_too_low project_not_found invalid_period rate_limited test_not_found ambiguous_test internal_error invalid_parameter run_not_found error_not_found

code

required

Allowed values: tier_too_low

Example

{
  "code": "tier_too_low"
}

404

Error: project_not_found

Media typeapplication/json

object

error

required

A sentence for a human. May be reworded.

string

code

required

Stable slug - match on this, not on the sentence.

string

Allowed values: missing_key invalid_key wrong_key_type key_revoked key_expired tier_too_low project_not_found invalid_period rate_limited test_not_found ambiguous_test internal_error invalid_parameter run_not_found error_not_found

code

required

Allowed values: project_not_found

Example

{
  "code": "project_not_found"
}

429

Rate limited by the edge firewall. No JSON body and no Retry-After - back off for at least 60 s.

500

Error: internal_error

Media typeapplication/json

object

error

required

A sentence for a human. May be reworded.

string

code

required

Stable slug - match on this, not on the sentence.

string

Allowed values: missing_key invalid_key wrong_key_type key_revoked key_expired tier_too_low project_not_found invalid_period rate_limited test_not_found ambiguous_test internal_error invalid_parameter run_not_found error_not_found

code

required

Allowed values: internal_error

Example

{
  "code": "internal_error"
}