GET v1/{subscriptionID}/filteredLists/{filteredListID}

Gets a filtered list.

Request Information

URI Parameters

Name	Description	Type	Additional information
subscriptionID	The Circle subscription ID.	globally unique identifier	Required
filteredListID	The filtered list ID to be retrieved.	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Returns a filtered list for the specified filtered list ID.

FilteredListModel

Name	Description	Type	Additional information
ID	Gets the filtered list ID.	globally unique identifier	None.
SubscriptionID	Gets the subscription ID of the filtered list.	globally unique identifier	None.
ProjectID	Gets the project ID of the filtered list.	globally unique identifier	None.
Name	Gets and sets the filtered list name.	string	None.
CreationTime	Gets the creation time of the filtered list.	date	None.
Creator	Gets the user who created the filtered list.	UserViewModel	None.
ModificationTime	Gets the last modification time of the filtered list.	date	None.
Modifier	Gets the user who was the last to modify the filtered list.	UserViewModel	None.
Description	Gets and sets the filtered list description.	string	None.
PlanFilterName	Gets and sets the plan filter name of the filtered list.	string	None.
EventFilters	Gets and sets the event filters of the filtered list.	Collection of EventFilterModel	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": "170f5112-3b81-4d10-8791-cd27974b0307",
  "SubscriptionID": "07d60735-6f7c-4c82-ab78-719bcaa32fb4",
  "ProjectID": "b7b043cd-ce9a-48de-a505-159726684f90",
  "Name": "sample string 4",
  "CreationTime": "2021-12-02T21:24:35.9635523Z",
  "Creator": {
    "ID": "f3cc39f3-38f3-4b43-97a4-908c1d785685",
    "Name": "sample string 2"
  },
  "ModificationTime": "2021-12-02T21:24:35.9635523Z",
  "Modifier": {
    "ID": "f3cc39f3-38f3-4b43-97a4-908c1d785685",
    "Name": "sample string 2"
  },
  "Description": "sample string 7",
  "PlanFilterName": "sample string 8",
  "EventFilters": [
    {
      "TouchPointID": "c4c44fe7-a558-483b-9d0c-45b73ae52d53",
      "TouchPoint": {
        "FriendlyID": "sample string 1",
        "ID": "05a63985-749d-4991-838e-c43f2a222275",
        "Name": "sample string 3",
        "Type": 1,
        "Status": 1,
        "ModificationTime": "2021-12-02T21:24:35.9635523Z",
        "Modifier": {
          "ID": "f3cc39f3-38f3-4b43-97a4-908c1d785685",
          "Name": "sample string 2"
        }
      },
      "EventType": 1,
      "TrackingActionName": "sample string 2",
      "EventCondition": {
        "Comparison": {
          "Parameter": "sample string 1",
          "Operand": 1
        },
        "Type": 1
      }
    },
    {
      "TouchPointID": "c4c44fe7-a558-483b-9d0c-45b73ae52d53",
      "TouchPoint": {
        "FriendlyID": "sample string 1",
        "ID": "05a63985-749d-4991-838e-c43f2a222275",
        "Name": "sample string 3",
        "Type": 1,
        "Status": 1,
        "ModificationTime": "2021-12-02T21:24:35.9635523Z",
        "Modifier": {
          "ID": "f3cc39f3-38f3-4b43-97a4-908c1d785685",
          "Name": "sample string 2"
        }
      },
      "EventType": 1,
      "TrackingActionName": "sample string 2",
      "EventCondition": {
        "Comparison": {
          "Parameter": "sample string 1",
          "Operand": 1
        },
        "Type": 1
      }
    }
  ]
}