Search recipients

get

https://{host}/platform/exchangedata/v1/sharekeys/{shareKey}/recipients

Returns a list of recipients.

A recipient is a Intelligent Risk Platform tenant has been "whitelisted" to send and receive exchange data (e.g. EDMs and analysis data) by another tenant through Risk Data Exchange.

For each recipient, this operation returns a recipientShareKey, recipientShareKeyName, and status.

This operation supports response filtering based on the value of a subset of properties. Depending on the property, you may use a combination of comparison operators, list operators, and logical operators.

Path Params

shareKey

string

required

ID of share key

Query Params

filter

string

Query string to select response data based on property values. Operators depend on the data type of the property.

Property	Comparison	List	Logical
`recipientShareKeyName`	`=` `!=` `LIKE` `NOT LIKE`	`IN` `NOT IN`	`AND` `OR`
`status`	`=` `!=` `LIKE` `NOT LIKE`	`IN` `NOT IN`	`AND` `OR`

See Filtering Responses.

sort

string

Defaults to status ASC

Comma-delimited list of properties. Sort order defined by one of ASC (ascending) or DESC (descending).

Supported properties: recipientShareKeyName, status`. See Response Pagination.

limit

int32

1 to 1000

Defaults to 100

Number of retrieved records to display on the page.

offset

int32

Defaults to 0

Number of the page displaying the returned records, starting at 0.

Responses

200Success

400Bad Request

401Unauthorized

403Forbidden: Access to this resource is denied or not authorized to perform the "Manage Data Exchange Share Keys OR Access Data Exchange Share Keys" action.

404Not found

500Internal Server Error