List project resources

Looks up the reference things that belong to a project, such as its people, labels, settings, skills, and agents.

Example: “List the users in my project”

Usage: pick what you want with resource: users, labels, settings, skills, agents, or agent_settings. By default you get the full list. To see the details of one item instead, add its resource_id (supported for users, skills, and agents only). For users, pass the id whoami gave you as resource_id to read your own record in this project, like your role here. Longer lists come back in pages.

Response: the matching items for the resource you chose, or the full details of a single item when you pass a resource_id.

POST /api/v1/business/project-resources/query

List project resources

cURL

curl --request POST \
  --url https://api.example.com/api/v1/business/project-resources/query \
  --header 'Content-Type: application/json' \
  --header 'x-project-id: <x-project-id>' \
  --data '
{
  "resource_id": "<string>",
  "settings_resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "page": 1,
  "size": 50,
  "setting_names": [],
  "cursor": "<string>",
  "limit": 50
}
'

200

{
  "id": "<string>",
  "full_name": "<string>",
  "photo_url": "<string>",
  "role": "super_admin"
}

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

200

application/json

Successful Response

ProjectUser

Listing[ProjectUser]

Listing[LabelResponse]

OffsetPage[SettingRead]

AgentSkillDetailResponse

Listing[AgentSkillResponse]

AgentResponse

CursorPage[AgentListResponseItem]

CursorPage[AgentSettingsItem]

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