Skip to content

Resolve

Resolve endpoints answer who should handle a workflow question and expose auditable resolve request history.

MethodPathRequired scope
POST/api/v1/resolveapi:resolve
GET/api/v1/resolve-requestsapi:resolve-requests:read
GET/api/v1/resolve-requests/:idapi:resolve-requests:read
Terminal window
curl -X POST "https://roster.example.com/api/v1/resolve" \
-H "Authorization: Bearer ${ROSTER_API_KEY}" \
-H "Content-Type: application/json" \
-d '{
"query": "Who should handle vendor security review for Atlas onboarding?",
"project_id": "proj_123",
"scope": "all",
"mode": "live"
}'

scope accepts participants, records, sources, members, metadata, projects, or all. mode accepts test or live.

Resolve uses project status and project read access:

  • Without project_id, Resolve receives only readable live projects, even in mode: "test".
  • A live project can be resolved explicitly in mode: "test" or mode: "live" when the caller has read access.
  • A test project can be resolved only with explicit project_id, mode: "test", and admin or project-owner access.
  • draft and archived projects are excluded from Resolve.
Terminal window
curl "https://roster.example.com/api/v1/resolve-requests?project_id=proj_123&resolution_status=success&limit=25" \
-H "Authorization: Bearer ${ROSTER_API_KEY}"

Supported filters include project_id, actor_id, resolution_status, created_after, created_before, query, and limit. resolution_status accepts success, not_found, out_of_scope, or error. Date filters accept ISO date-time strings. query searches the original Resolve request text. limit accepts values from 1 to 100 and defaults to 25.