GET journeys

[HTTP GET] ~/journeys

Description: Get a List of Journeys

Request Information

ODATA Queryable

URI Parameters

None.

Body Parameters

None

Response Information

Description

Successful Response - OK (200):

A collection of Journeys

Response Content : Collection of Campaign

Name	Type	Additional information
Id	integer	None.
Name	string	None.
AccountId	integer	None.
ListId	integer	None.
StartDate	date	None.
EndDate	date	None.
CmLink	string	None.
Comment	string	None.
Status	string	None.
Reach	integer	None.
Interactions	integer	None.
Unsubscribes	integer	None.
ShowInAgentPortal	boolean	None.
Tags	Collection of string	None.
Emails	Object	None.
LandingPages	Object	None.
TextMessages	Object	None.
EDocuments	Object	None.
Channels	string	None.

Response Codes:

200 - OK
- List of Journeys was retrieved and returned successfully.
401 - Unauthorized
- Request has been denied as it lacks valid Authentication credentials.
403 - Forbidden
- The User does not have the relevant permissions to perform this action.
500 - InternalServerError
- An error occurred while processing this request.

Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "Name": "sample string 2",
    "AccountId": 3,
    "ListId": 1,
    "StartDate": "2024-12-27T18:17:49.5710471+00:00",
    "EndDate": "2024-12-27T18:17:49.5710471+00:00",
    "CmLink": "sample string 4",
    "Comment": "sample string 5",
    "Status": "sample string 6",
    "Reach": 7,
    "Interactions": 8,
    "Unsubscribes": 9,
    "ShowInAgentPortal": true,
    "Tags": [
      "sample string 1",
      "sample string 2"
    ],
    "Emails": {},
    "LandingPages": {},
    "TextMessages": {},
    "EDocuments": {},
    "Channels": "sample string 15"
  },
  {
    "Id": 1,
    "Name": "sample string 2",
    "AccountId": 3,
    "ListId": 1,
    "StartDate": "2024-12-27T18:17:49.5710471+00:00",
    "EndDate": "2024-12-27T18:17:49.5710471+00:00",
    "CmLink": "sample string 4",
    "Comment": "sample string 5",
    "Status": "sample string 6",
    "Reach": 7,
    "Interactions": 8,
    "Unsubscribes": 9,
    "ShowInAgentPortal": true,
    "Tags": [
      "sample string 1",
      "sample string 2"
    ],
    "Emails": {},
    "LandingPages": {},
    "TextMessages": {},
    "EDocuments": {},
    "Channels": "sample string 15"
  }
]

application/csp-report

Sample:

[{"Id":1,"Name":"sample string 2","AccountId":3,"ListId":1,"StartDate":"2024-12-27T18:17:49.5710471+00:00","EndDate":"2024-12-27T18:17:49.5710471+00:00","CmLink":"sample string 4","Comment":"sample string 5","Status":"sample string 6","Reach":7,"Interactions":8,"Unsubscribes":9,"ShowInAgentPortal":true,"Tags":["sample string 1","sample string 2"],"Emails":{},"LandingPages":{},"TextMessages":{},"EDocuments":{},"Channels":"sample string 15"},{"Id":1,"Name":"sample string 2","AccountId":3,"ListId":1,"StartDate":"2024-12-27T18:17:49.5710471+00:00","EndDate":"2024-12-27T18:17:49.5710471+00:00","CmLink":"sample string 4","Comment":"sample string 5","Status":"sample string 6","Reach":7,"Interactions":8,"Unsubscribes":9,"ShowInAgentPortal":true,"Tags":["sample string 1","sample string 2"],"Emails":{},"LandingPages":{},"TextMessages":{},"EDocuments":{},"Channels":"sample string 15"}]

application/xml, text/xml

Sample:

<ArrayOfCampaign xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/W50Common.Models.DTO">
  <Campaign>
    <AccountId>3</AccountId>
    <Channels>sample string 15</Channels>
    <CmLink>sample string 4</CmLink>
    <Comment>sample string 5</Comment>
    <EDocuments />
    <Emails />
    <EndDate>2024-12-27T18:17:49.5710471+00:00</EndDate>
    <Id>1</Id>
    <Interactions>8</Interactions>
    <LandingPages />
    <ListId>1</ListId>
    <Name>sample string 2</Name>
    <Reach>7</Reach>
    <ShowInAgentPortal>true</ShowInAgentPortal>
    <StartDate>2024-12-27T18:17:49.5710471+00:00</StartDate>
    <Status>sample string 6</Status>
    <Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Tags>
    <TextMessages />
    <Unsubscribes>9</Unsubscribes>
  </Campaign>
  <Campaign>
    <AccountId>3</AccountId>
    <Channels>sample string 15</Channels>
    <CmLink>sample string 4</CmLink>
    <Comment>sample string 5</Comment>
    <EDocuments />
    <Emails />
    <EndDate>2024-12-27T18:17:49.5710471+00:00</EndDate>
    <Id>1</Id>
    <Interactions>8</Interactions>
    <LandingPages />
    <ListId>1</ListId>
    <Name>sample string 2</Name>
    <Reach>7</Reach>
    <ShowInAgentPortal>true</ShowInAgentPortal>
    <StartDate>2024-12-27T18:17:49.5710471+00:00</StartDate>
    <Status>sample string 6</Status>
    <Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Tags>
    <TextMessages />
    <Unsubscribes>9</Unsubscribes>
  </Campaign>
</ArrayOfCampaign>