---
title: "List custom stop properties"
method: GET
path: "/team/customStopProperties"
tags: ["Team"]
---

# List custom stop properties

`GET /team/customStopProperties`

## Request

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

Returns a list of custom stop properties definitions.

## Response `200`

The set of custom stop properties.

- object: The set of custom stop properties.
  - `customStopProperties` CustomStopPropertySchema[], required: The set of custom stop properties.
    - `id` string, required: The custom stop property id
    - `name` string, required: The name of the custom stop property
    - `visibleToDrivers` boolean, required: Whether this custom stop property is visible to drivers.
    - `visibleToRecipients` boolean, required: Whether this property is visible to recipients.

## Other responses

- `400`: Query parameters are invalid
- `401`: Unauthorized
- `403`: Feature not included in your team subscription
- `500`: An internal server error occurred
- `default`: The default error model

---

[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)