Remove users from Space

🚫 Remove Users from Space

Allows external clients to remove one or more users from a specific space.

HTTP Method

DELETE

Endpoint

/api/v1/admin/community/groups/users

Headers

Name	Type	Required	Description
x-api-key	String	✅ Yes	API key provided by the Networked Team. Used to authenticate external client requests.
spaceId	String	✅ Yes	UUID of the target group (space) to remove users from. Identifies which group the operation applies to.
Content-Type	String	✅ Yes	Must be `application/json`.

Query Parameters

Name	Type	Required	Description
userId	String	✅ Yes	User ID(s) to remove from the group. Pass a single UUID, or multiple UUIDs separated by commas (e.g. `uuid-1,uuid-2`). Whitespace around commas is trimmed.

Sample Request

DELETE /api/v1/admin/community/groups/users?userId=dcb88996-2317-428d-b10d-07ecb5de95ee

Batch Request Example

DELETE /api/v1/admin/community/groups/users?userId=dcb88996-2317-428d-b10d-07ecb5de95ee,a1b2c3d4-e5f6-7890-abcd-ef1234567890

Sample Response (Success)

{
  "data": {},
  "error": false,
  "message": "Success"
}

Response Interface

interface RemoveUsersFromSpaceResponse {
  data: Record<string, never>;
  error: boolean;
  message: string;
}

Response Field Descriptions

Field	Type	Description
data	Object	Empty object on success.
error	Boolean	`false` when the operation succeeds.
message	String	Descriptive message for the API outcome (e.g. `"Success"`).

Business Rules

spaceId (header) sets the target Space.

For userId in the query string, the user must belong to that space .

Common Error Responses

Code	Message (typical)	When
512	Validation error	Missing or invalid `userId` query parameter.
525	No data found	Target group (community) not found for the given `spaceId`.
555	The provided X-API-KEY is invalid or has expired.	Invalid or inactive `x-api-key`.
429	Too many requests	Rate limit exceeded (100 requests/minute per client).

Reference

🔗 Standard Response Codes

Notes

This API must be used with a valid x-api-key.

spaceId is required in the header and identifies the target group; userId is required in the query string and identifies the user to remove.

This endpoint does not use a request body — pass userId as a query parameter only.

Users with no existing group membership are skipped without failing the whole request.

Rate limiting applies to all requests authenticated with x-api-key.

If x-api-key is omitted the endpoint will fail.

Apidog field checklist

Field	Value
Summary	Remove users from Space
Method	`DELETE`
Path	`/api/v1/admin/community/groups/users`

Headers

Name	Required	Example
`x-api-key`	✅ Yes	`{{x-api-key}}`
`spaceId`	✅ Yes	`{{spaceId}}`
`Content-Type`	✅ Yes	`application/json`
`userid`	No	—

Query parameters

Name	Required	Example
`userId`	✅ Yes	`dcb88996-2317-428d-b10d-07ecb5de95ee`

Request body

None. Remove the required empty JSON body if present — the handler reads userId from req.query, not the body.

200 response example

{
  "data": {},
  "error": false,
  "message": "Success"
}

cURL example

Batch: