latestOpenAPI 3.1.1Proprietary – Contact us for usage terms2026-08-20173183551.4 KB

9da73dd2f99e

blacklist

Get a user's personal blacklist

Retrieves the phone numbers blacklisted by a specific user. A user's personal blacklist contains numbers that are blocked from calling or being called by this user specifically. This is distinct from the team-level blacklist (GET /blacklists/numbers). Results are paginated using limit_count and limit_offset.

Permission: Users Read required.

Monitoring impact:

  • OFF: Returns the blacklist only if userId matches your own user ID. Requesting another user's blacklist returns 401.
  • ON: Returns any user's personal blacklist.
get/users/{userId}/blacklists/numbers

Path parameters

userIdinteger required
Example:123456

The identifier of the user

Query parameters

limit_countinteger

The number of results (default: 100).

limit_offsetinteger

Number of elements that will be ignored (default: 0).

Response

Successful operation

team_idinteger

Your team identifier

limit_offset_settedinteger

Number of elements that will be ignored (default: 0).

limit_count_settedinteger

The number of results (default: 100).

total_blacklist_countinteger

The total number of blacklisted phone numbers

blacklist_list_countinteger

The size of the array <em>blacklist_list</em>, corresponds to the number of blacklisted phone numbers retrieved.

Example response

{
  "team_id": 123456,
  "limit_offset_setted": 1,
  "limit_count_setted": 10,
  "total_blacklist_count": 37,
  "blacklist_list_count": 1,
  "blacklist_list": [
    {
      "user_id": 12345,
      "team_id": 123456,
      "number": 33184800000,
      "comment": "Unfriendly",
      "direction": "IN"
    }
  ]
}