---
title: "List unassigned stops"
method: GET
path: "/unassignedStops"
tags: ["Unassigned Stops"]
---

# List unassigned stops

`GET /unassignedStops`

## Request

- Base URL: `https://api.spoke.com/public/v1`
- URL: `https://api.spoke.com/public/v1/unassignedStops`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/spoke/apis/spoke-api/docs/unassignedStops/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `pageToken` string
- `maxPageSize` number
- `filter` object
  - `externalId` string: Filter by the `recipient.externalId` field, exact match

## Response `200`

Success

- object: Success
  - `unassignedStops` UnassignedStopSchema[], required: The unassignedStops.
    - `id` string, required
    - `depot` string, required: The depot that this unassigned stop belongs to.
    - `address` object, required: The address of the stop.
      - `address` string, required: The address of the stop.
      - `addressLineOne` string, required: The first line of the address.
      - `addressLineTwo` string, required: The second line of the address.
      - `latitude` number, nullable, required: The latitude of the address in decimal degrees.
      - `longitude` number, nullable, required: The longitude of the address in decimal degrees.
      - `placeId` string, nullable, required: The identifier of the place corresponding to this stop on Google Places
      - `placeTypes` string[], required: Array of strings that is provided by the Google AutoCompleteAPI
    - `barcodes` string[], required: List of Barcode IDs associated with the stop.
    - `allowedDrivers` string[], required: The driver IDs that can be assigned to this stop.
    - `notes` string, nullable, required: Notes for the stop.
    - `packageCount` number, nullable, required: The number of packages.
    - `weight` object, nullable, required: Weight information for the stop.
      - `amount` number, required: The weight amount for this stop.
      - `unit` 'kilogram' | 'pound' | 'metric-ton', required: The weight unit in which the amount is specified (defined at team's capacity unit).
    - `orderInfo` object, required: The order information of the stop.
      - `products` string[], required: The products of the stop.
      - `invoiceNumber` string, nullable, required: Invoice number associated with the order.
      - `sellerName` string, nullable, required: Name of the seller where the order is from.
      - `sellerOrderId` string, nullable, required: Id of the seller where the order is from.
      - `sellerWebsite` string, nullable, required: Website of the seller where the order is from.
    - `recipient` object, required: The recipient of the stop.
      - `name` string, nullable, required: The name of the recipient.
      - `email` string, nullable, required: The email of the recipient.
      - `phone` string, nullable, required: The phone of the recipient.
      - `externalId` string, nullable, required: The external id of the recipient.
    - `activity` 'delivery' | 'pickup'
    - `trackingLink` string, nullable, required: The recipient tracking link.
    - `timing` object, required: The timing data of the stop.
      - `timeWindows` object[], required: Ordered arrival windows for this stop.
        - `earliestAttemptTime` TimeOfDaySchema, required: Time of day in hours and minutes. Uses a 24 hour clock.
          - `hour` integer, required: Hour of the day
          - `minute` integer, required: Minute of the hour
        - `latestAttemptTime` TimeOfDaySchema, required: Time of day in hours and minutes. Uses a 24 hour clock.
          - `hour` integer, required: Hour of the day
          - `minute` integer, required: Minute of the hour
      - `estimatedAttemptDuration` number, nullable, required: Time that the driver estimates to spend on the stop to do his job (deliver a parcel, visit a client, etc) in seconds.
      - `earliestAttemptTime` TimeOfDaySchema, required: Time of day in hours and minutes. Uses a 24 hour clock.
        - `hour` integer, required: Hour of the day
        - `minute` integer, required: Minute of the hour
      - `latestAttemptTime` TimeOfDaySchema, required: Time of day in hours and minutes. Uses a 24 hour clock.
        - `hour` integer, required: Hour of the day
        - `minute` integer, required: Minute of the hour
    - `optimizationOrder` 'first' | 'last' | 'default'
    - `paymentOnDelivery` object, nullable, required: The payment due upon delivery also known as "Cash on Delivery".
      - `amount` integer, nullable, required: The amount *in minor units* (e.g. cents) to be collected upon delivery.
      - `currency` string, required: The payment's currency in ISO 4217 standard.
    - `proofOfAttemptRequirements` object, required: The proof of attempt requirements of the stop.
      - `enabled` boolean, nullable, required: Whether the proof of attempt is enabled.This only works if the team subscription has access to proof of delivery
    - `customProperties` object, nullable, required: Custom properties of the stop, can be used to store additional information.
    - `clientId` string, nullable, required: The associated Client ID of the Spoke Connect
  - `nextPageToken` string, nullable, required: The next page token.

## Other responses

- `400`: Query parameters are invalid
- `401`: Unauthorized
- `500`: An internal server error occurred

---

[API](https://skmtc.dev/spoke/apis/spoke-api.md) - [All operations](https://skmtc.dev/spoke/apis/spoke-api/llms.txt) - [OpenAPI document](https://skmtc.dev/spoke/apis/spoke-api/revisions/a09d9194ae1c?raw)