# [EXPERIMENTAL] Get cursor-based deployments

Retrieve deployments in bulk using cursor-based paging (see the Cursor-based pagination documentation on the PTV Developer Portal).
Deployments without a planning_id are externally managed Deployments. 
Deployments with a planning_id are managed by releasing or unreleasing routes in PTV OptiFlow.

Endpoint: GET /deployment
Version: 1.27.2
Security: clientCredentials

## Query parameters:

  - `cursor` (string)
    The cursor of the page to return. No cursor is expected for the initial request. The cursors returned by this endpoint can be used for subsequent requests.

  - `limit` (integer)
    Number of results to return per page.

## Response 200 fields (application/json):

  - `data` (array)
    The set of results for the current page.

  - `data.id` (string)
    The unique deployment ID.
    Example: "deployment-123"

  - `data.resource_combination_id` (string)
    The ID of the associated resource combination, if any.
    Example: "rc-456"

  - `data.availability_id` (string)
    The ID of the associated availability, if any.
    Example: "avail-789"

  - `data.employee_id` (string)
    The ID of the employee assigned to this deployment.
    Example: "employee-42"

  - `data.transport_resource_ids` (array)
    The IDs of the transport resources assigned to this deployment.
    Example: ["truck-1","trailer-2"]

  - `data.start` (object)

  - `data.start.at` (string, required)
    When the deployment starts.
    Example: "2021-01-01T08:00:00Z"

  - `data.start.location` (object, required)
    Location for the deployment. For external deployments, either address or home_base must be provided, but not both.

  - `data.start.location.home_base` (object)
    The business_id of a known HomeBase in the system for this deployment location.

  - `data.start.location.home_base.business_id` (string, required)
    The unique identifier of a HomeBase.
    Example: "depot-1"

  - `data.start.location.address` (object)
    Address for this deployment location.

  - `data.start.location.address.name` (string, required)
    A name by which to identify this location. If used as a start_location, this is used for matching colocated entities.
    Example: "Conundra"

  - `data.start.location.address.address_line` (string)
    The address line of this location's address. Can contain street, house number, bus and more.
    Example: "Voordries 41b"

  - `data.start.location.address.city` (string)
    The name of the locality of this location.

Required when no geo_point is provided.
    Example: "Oosterzele"

  - `data.start.location.address.zip_code` (string)
    The ZIP code of the locality of this location.

Required when no geo_point is provided.
    Example: "9860"

  - `data.start.location.address.country_code` (string)
    The ISO3166-1 alpha-2 two letter country code for this location.

Required when no geo_point is provided.

  - `data.start.location.address.geo_point` (object)

  - `data.start.location.address.geo_point.latitude` (number, required)
    Example: 50.9514048

  - `data.start.location.address.geo_point.longitude` (number, required)
    Example: 3.8067878

  - `data.start.location.address.geo_point.resolved` (object)
    Indicates whether the address is resolved.

  - `data.start.location.address.geo_point.resolved.geocoded` (boolean)
    Example: true

  - `data.start.location.address.geo_point.resolved.address` (string)
    Example: "Voordries 31 bus B, 9860 Oosterzele"

  - `data.start.location.address.geo_point.resolved.precision` (integer)
    Example: 9

  - `data.end` (object)

  - `data.end.at` (string, required)
    When the deployment ends.
    Example: "2021-01-01T17:00:00Z"

  - `data.total_break_time` (string)
    Total break time during the deployment, formatted as ISO-8601 duration.
    Example: "PT1H"

  - `data.planning_id` (string)
    The ID of the planning that created this deployment, if any.
    Example: "planning-123"

  - `cursors` (object)
    The cursors represent pointers to pages of results in relation to the page that was retrieved by the current request. These pointers are nullable. For more information
on these pointers, view the Developer Portal.

  - `cursors.previous` (string)
    Pointer to the previous page of results.

  - `cursors.self` (string)
    Pointer to the current page of results. When changing the limit in subsequent requests, the first 'limit' results will be contained in the page.

  - `cursors.next` (string)
    Pointer to the next page of results.

## Response 400 fields (application/problem+json):

  - `title` (string)
    A short, summary of the problem.
    Example: "Validation exception"

  - `detail` (string)
    A detailed explanation specific to this problem.
    Example: "The field contains invalid business formatting."

  - `violations` (array)

  - `violations.field` (string)
    Example: "path.to.field"

  - `violations.message` (string)
    Example: "Field is required"


## Response 401 fields