GET api/BlockedUsers

Returns all blocked users for the authenticated tenant. Only 100 blocked user can be returned at a time. The following OData query options are allowed: $filter, $orderby, $select, $skip, $top.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of BlockedUser
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

UserId

ID of the blocked user.

string

Required

Created

The date when the user was blocked (in the ISO 8601 format).

date

Required

Status Codes

All HTTP status codes must be expected, but the following status codes are the most probable:

  • OK (200) - All found blocked users are successfully returned.
  • BadRequest (400) - The OData query is invalid.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": "30342e3d-a821-4d6b-a3e7-e7908c9b8d93",
    "UserId": "sample string 2",
    "Created": "2024-09-11T10:49:55.8431312+00:00"
  },
  {
    "Id": "30342e3d-a821-4d6b-a3e7-e7908c9b8d93",
    "UserId": "sample string 2",
    "Created": "2024-09-11T10:49:55.8431312+00:00"
  }
]