Skip to content
v3 API/
/
Search assignable items (...

Search assignable items (audits, journeys, rules etc) for specified email

Request

POST /v3/notification-center/target-items/{itemType}/search
Security
API_Key
Path
itemTypestringrequired
Enum:"AUDIT""WEB_JOURNEY""RULE""ALERT""USAGE_ALERT""EMAIL_INBOX_MESSAGE_RECEIVED""EMAIL_INBOX_MESSAGE_PROCESSED""SCHEDULED_EXPORT"
Query
sizeinteger, [ 50 .. 1000 ]
Default:50
sortBystring
Enum:"IS_ASSIGNED""ITEM_NAME""RUN_DATE"
pageinteger, >= 0

Page number, starts with 0

Default:0
sortDescboolean

Controls sorting order

Default:false
Bodyapplication/jsonrequired
emailstring, non-emptyrequired

email to search for

itemNamestring, non-empty

optional "item name contains substring" filter

itemLabelsArray of integers, non-empty

non-empty array of labels present on an item. When multiple labels specified, target item is expected to have all of them (condition works as "AND" for all labels specified)

isAssignedboolean
  • when TRUE - only target items with the specified email currently assigned will be returned;
  • when FALSE - only target items with the specified email currently NOT assigned will be returned;
  • when UNDEFINED or NULL - flag is ignored.
POST
/v3/notification-center/target-items/{itemType}/search
curl -i -X POST \
  'https://api.observepoint.com/v3/notification-center/target-items/{itemType}/search?size=50&sortBy=IS_ASSIGNED&page=0&sortDesc=false' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "string",
    "itemName": "string",
    "itemLabels": [
      223
    ],
    "isAssigned": true
  }'

Responses

Items that have specified email both assigned and not assigned

Bodyapplication/json
metadataobjectrequired

Common metadata for iterable

itemsArray of objectsrequired
Response
{
  "metadata": {
    "pagination": { … }
  },
  "items": [
    { … }
  ]
}