SPspreedly
receivers

List created receivers

Changed on

Retrieve an ordered and paginated list of all receivers in the authenticated environment.

get/receivers

Request

Query parameters

orderstring

The order of the returned list. Default is asc, which returns the oldest records first. To list newer records first, use desc.

since_tokenstring

The token of the item to start from (e.g., the last token received in the previous list if iterating through records)

statestring

The state of the receivers to filter for. Valid values are created, retained, and redacted. If not provided, receivers in the redacted state will be excluded.

receiver_typestring

The type of the receivers to filter for. If not provided, all receiver types will be returned.

Response

Successful

Changes

  • a33f10acbf55Revision changes
    • info

      added the new optional query request parameter receiver_type

    • info

      added the new optional query request parameter state