blocked resource endpoint

URL: /groups/<id>/memberships/@blocked.<format>

Supported Methods

GET	Get a list of relationships that have the Blocked type between users and the selected groups. (Restricted to group admin.)

Query String Arguments

start-index

Index of the first item to return. The first item in the list has index 1.

max-results

Maximum number of items to return in the list response.

Resource Type

This endpoint returns an object of type List<Relationship>.

entries (array<Relationship>)

The items within the selected range.

totalResults (integer)

The total number of items in the whole list of which this object is a chunk.

Client Library Methods for PHP

Get a list of relationships that have the Blocked type between users and the selected groups. (Restricted to group admin.)

$tp->groups->getBlockedMemberships(array(

    # Required Parameters
    "id" => $id,

    # Optional Parameters
    "limit" => $limit,
    "offset" => $offset,

))