Get all lists

Request

Retrieves all lists of the tenant. To return lists that include a specific recommendation, add item_id to the query.

Security

risk_access_token

Query

item_idstring

ID of the list item.

curl -i -X GET \
  'https://api.sbx.transmitsecurity.io/risk/v1/lists?item_id=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Matching lists

Bodyapplication/json

Array [

list_namestringrequired

The list title.

tenant_idstringrequired

ID of the tenant.

list_typestringrequired

The type of recommendation list.

Value:"action_id"

creatorstringrequired

The list owner.

list_idstringrequired

ID of the recommendation list.

itemsArray of objectsrequired

created_datestring, (date-time)required

The timestamp when the list was created.

updated_datestring, (date-time)required

The timestamp when the list was updated.

]

Response

[
  {
    "list_name": "string",
    "tenant_id": "string",
    "list_type": "action_id",
    "creator": "string",
    "list_id": "string",
    "items": [ … ],
    "created_date": "2019-08-24T14:15:22Z",
    "updated_date": "2019-08-24T14:15:22Z"
  }
]