Skip to main content

routePlanningFieldReps

Requires permission visits:journey-plan:manage.

Lists the field reps route planning can plan, sorted by name: active staff users holding the permission to run visits. These are the reps the rules may select, a run plans by default and the team board shows. 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:

query RoutePlanningFieldReps {
  routePlanningFieldReps {
    id
    name
  }
}

Response:

{
  "data": {
    "routePlanningFieldReps": [
      {
        "id": "id",
        "name": "string"
      }
    ]
  }
}
routePlanningFieldReps: [RoutePlanningFieldRep!]!

Type​

RoutePlanningFieldRep object​

A field rep route planning can plan: an active staff user holding the permission to run visits.