Skip to main content
GET
Get Block Status
Returns only the acting user’s outbound block state — whether I block :userId. This powers a block/unblock toggle in your app’s UI.
This endpoint is outbound-only by design. It never reveals the inbound direction (whether :userId has blocked the caller). Exposing the inbound state would let a blocked user poll this endpoint to discover a block — the exact disclosure the feature exists to prevent.
Requires the moderation bundle. A project without the moderation bundle returns 403 database/tables-not-available. See Bundles.

Path Parameters

string
required
The Sublay user ID (UUID) of the user to check block status against (the target).

Query Parameters

string
The user whose outbound state is being checked (the blocker). Only service/master keys may supply an actingUserId other than the caller’s own; with a user token the blocker is derived from the token.

Response

On success, returns HTTP 200.
boolean
true if the acting user blocks the target user; otherwise false.
string
ID of the block record. Present only when blocked is true.
string
ISO timestamp of when the block was created. Present only when blocked is true.

Error Responses

See Also