Recommend workspaces to join
The workspaces the caller should consider joining, best first. Suggest-only: this reads, and joining remains the separate explicit act PUT /workspaces/{workspace_id}/members/me.
Three signals are fused by reciprocal rank. detected_contributor — the caller's verified address appears in an onboarded repo's contributor history there. nearby — it is the parent, a child, or a sibling of a workspace the caller is already seated in and recently active in. text_match — with q, its name, display_name or description matched, using the same substring grammar as GET /workspaces?q=.
Only workspaces the caller can actually join right now are listed: active, in the account's shared tree, not the org root, not already joined, and with every ancestor already joined — so no suggestion answers 409 join X first.
The list is capped and has no window. page.total is absent because a fused ranking is not a count, and limit/offset/sort/filter[…] are refused rather than ignored. score is comparable within one response and meaningless across two: it is a sum of reciprocal ranks over this request's candidate set, never a probability or a similarity.
Request
- Base URL: https://api.atlan.com (the document declares no server; this is the origin it was published from)
- URL: https://api.atlan.com/registry/v1/workspaces/recommendations
- Auth: HTTP bearer
Query parameters
Optional substring needle over name, display_name and description, matched exactly as GET /workspaces?q= matches it. Contributes a third ranked signal rather than filtering the result.
Headers
Optional read-your-own-writes token. Echo the X-Atlan-Consistency-Token a recent write returned, and this read is pinned to at least that revision so it sees your own change instead of a stale replica. Omit it for the fastest read. An unrecognised token is ignored and the read still succeeds.
Response
OK
Changes
No recorded changes to this operation across all 1 revision of this API.