---
title: "The project's own rules"
method: GET
path: "/project"
---

# The project's own rules

`GET /project`

## Request

- Base URL: `https://xpost.to/api/v1`
- URL: `https://xpost.to/api/v1/project`
- Auth: HTTP bearer

What an agent is judged by, in one call: `timezone` (the clock a bare date-time is read on), `approval` (autopilot, the default, lets agent posts go; copilot holds them for a human), `guardrails` (the enabled rules, as configured, so a draft can comply instead of being rewritten after a 422), `posts_today` (this key's daily allowance, counted the same way the 429 counts it), and `queue` (the posting schedule and its next free slots, for `scheduled_at: "next_slot"`). Read-only, and deliberately nothing about members, billing or keys.

## Response `200`

Project rules

- object
  - `name` string, nullable
  - `timezone` string
  - `approval` object
    - `mode` 'copilot' | 'autopilot'
    - `agent_posts_held` boolean
    - `note` string
  - `signature` object
    - `default` string, nullable
    - `per_platform` object
    - `appended_automatically` boolean
  - `guardrails` object[]
    - `kind` string
    - `config` object
  - `posts_today` object, nullable
    - `limit` integer
    - `used` integer
    - `remaining` integer
  - `queue` object: The posting schedule (Project → Queue) and its next three free slots, so `scheduled_at: "next_slot"` is chosen with the times in view.
    - `configured` boolean
    - `slots` object[]
      - `time` string: HH:MM on the project's clock
      - `days` integer[]: 0=Sunday … 6=Saturday
    - `randomize` boolean
    - `next_slots` string[]: Soonest first. Empty with slots configured means the next four weeks are booked.
    - `how` string

## Other responses

- `401`: Missing or invalid API key
- `403`: Missing posts:read scope
- `429`: Rate limited

---

[API](https://skmtc.dev/xpost/apis/xpost-api.md) · [All operations](https://skmtc.dev/xpost/apis/xpost-api/llms.txt) · [OpenAPI document](https://skmtc.dev/xpost/apis/xpost-api/revisions/9f570fcfed6d?raw)