Skip to main content
POST
List project resources

Headers

x-project-id
string<uuid>
required

Project ID for tenant scoping

X-Workspace-Id
string<uuid> | null

Overrides the key's workspace

X-API-Key
string | null

User API key

Body

application/json
resource
enum<string>
required

Which project resource catalog to read.

Available options:
users,
labels,
settings,
skills,
agents,
agent_settings
resource_id
string | null

If set, fetch this one resource's detail instead of listing. Supported for users, skills, agents.

settings_resource_id
string<uuid> | null

For resource='settings': filter settings scoped to this resource's id.

resource_type
enum<string> | null

For resource='settings': filter settings by the type of resource they scope.

Available options:
agent,
task
setting_name
enum<string> | null

For resource='settings': filter to a single setting name.

Available options:
skip_review,
gated_tools,
gated_capabilities,
mcp_gated_tools
page
integer
default:1

For resource='settings': 1-based page number (offset pagination).

Required range: x >= 1
size
integer
default:50

For resource='settings': page size (offset pagination).

Required range: 1 <= x <= 100
role
enum<string> | null

For resource='agents': filter agents by role.

Available options:
orchestrator,
executor,
pipeline
setting_names
enum<string>[] | null

For resource='agent_settings': restrict to these setting names (defaults to all seeded settings).

Available options:
skip_review,
gated_tools,
gated_capabilities,
mcp_gated_tools
cursor
string | null

For resource='agents' or 'agent_settings': opaque cursor for the next page.

limit
integer
default:50

For resource='agents' or 'agent_settings': page size (cursor pagination).

Required range: 1 <= x <= 100

Response

Successful Response

id
string
required
full_name
string | null
required
photo_url
string | null
role
enum<string> | null

Preserve lowercase enum names to match the Writesonic DB enum values.

Available options:
super_admin,
admin,
member