journeyPlan

Requires permission visits:journey-plan:manage.

Returns one sales rep's journey plan, the route of planned visits, for one day, or null when there is neither a saved plan nor an unplanned stop that day. Requires permission to manage journey plans.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query JourneyPlan($planDate: DateTime!, $salesRepId: ID!) {
  journeyPlan(planDate: $planDate, salesRepId: $salesRepId) {
    id
    salesRepName
    createdAt
    notes
    planDate
    salesRepId
    visits {
      id
      partnerName
      status
      createdAt
      completedAt
      hasUnreadMessage
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query JourneyPlan($planDate: DateTime!, $salesRepId: ID!) {\n  journeyPlan(planDate: $planDate, salesRepId: $salesRepId) {\n    id\n    salesRepName\n    createdAt\n    notes\n    planDate\n    salesRepId\n    visits {\n      id\n      partnerName\n      status\n      createdAt\n      completedAt\n      hasUnreadMessage\n    }\n  }\n}",
  "variables": {
    "planDate": "2025-01-15T00:00:00Z",
    "salesRepId": "id"
  }
}
EOF

Variables:

{
  "planDate": "2025-01-15T00:00:00Z",
  "salesRepId": "id"
}

Response:

{
  "data": {
    "journeyPlan": {
      "id": "id",
      "salesRepName": "string",
      "createdAt": "2025-01-15T00:00:00Z",
      "notes": "string",
      "planDate": "2025-01-15T00:00:00Z",
      "salesRepId": "string",
      "visits": [
        {
          "id": "id",
          "partnerName": "string",
          "status": "CANCELLED",
          "createdAt": "2025-01-15T00:00:00Z",
          "completedAt": "2025-01-15T00:00:00Z",
          "hasUnreadMessage": true
        }
      ]
    }
  }
}

journeyPlan(
  planDate: DateTime!
  salesRepId: ID!
): JourneyPlan

Arguments

journeyPlan.planDate ● DateTime! non-null scalar

The day of the plan.

journeyPlan.salesRepId ● ID! non-null scalar

The ID of the sales rep.

Type

JourneyPlan object

A rep's plan for one day: the stops they will visit.