---
title: "Retrieve a custom stop property"
method: GET
path: "/team/customStopProperties/{customStopPropertyId}"
tags: ["Team"]
---

# Retrieve a custom stop property

`GET /team/customStopProperties/{customStopPropertyId}`

## Request

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

Returns a custom stop property definition.

## Path parameters

- `customStopPropertyId` string, required

## Response `200`

The definition of a custom stop property.

- object: The definition of a custom stop property.
  - `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`: ID format is invalid
- `401`: Unauthorized
- `403`: Feature not included in your team subscription
- `404`: The provided custom stop property id does not exist
- `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)