# Get cursor-based home bases

Retrieve home bases in bulk using cursor-based paging (see the Cursor-based pagination documentation on the PTV Developer Portal).

Endpoint: GET /home-base
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.business_id` (string)
    Example: "HB-GHENT-01"

  - `data.name` (string)
    Name of the home base
    Example: "Ghent - Headquarters"

  - `data.address` (object)
    Either address information should be present, or otherwise the geo point. The resolved information will be read only and be filled out after resolving.

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

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

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

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

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

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

Required when no geo_point is provided.

  - `data.address.geo_point` (object)

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

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

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

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

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

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

  - `data.plan_group` (string)
    the plan group to which this HomeBase belongs
    Example: "cargo planning"

  - `data.etag` (string)
    Example: "W/\"25\""

  - `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