GET v1/{subscriptionID}/projects/{projectID}/touchPoints

Gets all touchpoints in a project.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
subscriptionID

The Circle subscription ID.

globally unique identifier

Required

projectID

The project ID.

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Returns all touchpoints for the specified project ID.

Collection of TouchPointViewModel
NameDescriptionTypeAdditional information
FriendlyID

Gets the friendly ID of the touchpoint.

string

None.

ID

Gets the touchpoint ID.

globally unique identifier

None.

Name

Gets the touchpoint name.

string

None.

Type

Gets the touchpoint type.

TouchPointType

None.

Status

Gets the touchpoint status.

TouchPointStatus

None.

ModificationTime

Gets the last modification time of the touchpoint.

date

None.

Modifier

Gets the user who was the last to modify the touchpoint.

UserViewModel

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "FriendlyID": "sample string 1",
    "ID": "64e4574c-8892-4708-866f-ac982632aec4",
    "Name": "sample string 3",
    "Type": 1,
    "Status": 1,
    "ModificationTime": "2021-12-02T18:59:20.8119656Z",
    "Modifier": {
      "ID": "c19ce3fd-b14d-4043-bed6-404e9dc2cb2d",
      "Name": "sample string 2"
    }
  },
  {
    "FriendlyID": "sample string 1",
    "ID": "64e4574c-8892-4708-866f-ac982632aec4",
    "Name": "sample string 3",
    "Type": 1,
    "Status": 1,
    "ModificationTime": "2021-12-02T18:59:20.8119656Z",
    "Modifier": {
      "ID": "c19ce3fd-b14d-4043-bed6-404e9dc2cb2d",
      "Name": "sample string 2"
    }
  }
]