Circuit Team API

Endpoints to retrieve [Custom Stop Properties](/docs/models/customStopProperty).

Operations 2

GET /team/customStopProperties List custom stop properties #
GET /team/customStopProperties/{customStopPropertyId} Retrieve a custom stop property #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/circuit-team-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

circuit-team-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Spoke Team API
  description: This is the documentation of the Spoke Public API HTTP endpoints.
  version: v1
servers:
- url: https://api.spoke.com/public/v1
security:
- BasicAuth: []
tags:
- name: Team
  description: Endpoints to retrieve Custom Stop Properties.
paths:
  /team/customStopProperties:
    get:
      operationId: listCustomStopProperties
      summary: List custom stop properties
      tags:
      - Team
      description: Returns a list of custom stop properties definitions.
      responses:
        '200':
          description: The set of custom stop properties.
          content:
            application/json:
              schema:
                type: object
                properties:
                  customStopProperties:
                    type: array
                    items:
                      $ref: '#/components/schemas/customStopPropertySchema'
                    description: The set of custom stop properties.
                required:
                - customStopProperties
                definitions:
                  customStopPropertySchema:
                    type: object
                    properties:
                      id:
                        type: string
                        description: The custom stop property id
                      name:
                        type: string
                        description: The name of the custom stop property
                      visibleToDrivers:
                        type: boolean
                        description: Whether this custom stop property is visible to drivers.
                      visibleToRecipients:
                        type: boolean
                        description: Whether this property is visible to recipients.
                    required:
                    - id
                    - name
                    - visibleToDrivers
                    - visibleToRecipients
                    additionalProperties: false
                    description: The definition of a custom stop property.
                description: The set of custom stop properties.
        '400':
          description: Query parameters are invalid
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: The error message.
                  code:
                    type: string
                    description: The error code.
                  param:
                    type: string
                    description: The parameter that caused the error.
                  url:
                    type: string
                    description: The URL with more information about the error.
                required:
                - message
                description: Query parameters are invalid
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: The error message.
                  url:
                    type: string
                    description: The URL with more information about the error.
                required:
                - message
                description: Unauthorized
        '403':
          description: Feature not included in your team subscription
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: The error message.
                  code:
                    type: string
                    enum:
                    - feature_not_in_subscription
                  url:
                    type: string
                    enum:
                    - https://dispatch.spoke.com/paywall
                required:
                - message
                - code
                - url
                description: Feature not included in your team subscription
        '500':
          description: An internal server error occurred
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: The error message.
                  code:
                    type: string
                    description: The error code.
                  param:
                    type: string
                    description: The parameter that caused the error.
                  url:
                    type: string
                    description: The URL with more information about the error.
                required:
                - message
                description: An internal server error occurred
        default:
          description: The default error model
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: The error message.
                  code:
                    type: string
                    description: The error code.
                  param:
                    type: string
                    description: The parameter that caused the error.
                  url:
                    type: string
                    description: The URL with more information about the error.
                required:
                - message
                description: The default error model
  /team/customStopProperties/{customStopPropertyId}:
    get:
      operationId: getCustomStopProperty
      summary: Retrieve a custom stop property
      tags:
      - Team
      description: Returns a custom stop property definition.
      parameters:
      - schema:
          type: string
          maxLength: 50
        in: path
        name: customStopPropertyId
        required: true
        description: The custom stop property id
      responses:
        '200':
          description: The definition of a custom stop property.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: The custom stop property id
                  name:
                    type: string
                    description: The name of the custom stop property
                  visibleToDrivers:
                    type: boolean
                    description: Whether this custom stop property is visible to drivers.
                  visibleToRecipients:
                    type: boolean
                    description: Whether this property is visible to recipients.
                required:
                - id
                - name
                - visibleToDrivers
                - visibleToRecipients
                additionalProperties: false
                description: The definition of a custom stop property.
        '400':
          description: ID format is invalid
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: The error message.
                  code:
                    type: string
                    description: The error code.
                  param:
                    type: string
                    description: The parameter that caused the error.
                  url:
                    type: string
                    description: The URL with more information about the error.
                required:
                - message
                description: ID format is invalid
                title: The request is invalid
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: The error message.
                  url:
                    type: string
                    description: The URL with more information about the error.
                required:
                - message
                description: Unauthorized
        '403':
          description: Feature not included in your team subscription
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: The error message.
                  code:
                    type: string
                    enum:
                    - feature_not_in_subscription
                  url:
                    type: string
                    enum:
                    - https://dispatch.spoke.com/paywall
                required:
                - message
                - code
                - url
                description: Feature not included in your team subscription
        '404':
          description: The provided custom stop property id does not exist
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    anyOf:
                    - type: string
                      enum:
                      - Custom stop property not found
                    - type: string
                required:
                - message
                description: The provided custom stop property id does not exist
                title: Custom stop property not found
        '500':
          description: An internal server error occurred
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: The error message.
                  code:
                    type: string
                    description: The error code.
                  param:
                    type: string
                    description: The parameter that caused the error.
                  url:
                    type: string
                    description: The URL with more information about the error.
                required:
                - message
                description: An internal server error occurred
        default:
          description: The default error model
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: The error message.
                  code:
                    type: string
                    description: The error code.
                  param:
                    type: string
                    description: The parameter that caused the error.
                  url:
                    type: string
                    description: The URL with more information about the error.
                required:
                - message
                description: The default error model
components:
  schemas:
    customStopPropertySchema:
      type: object
      properties:
        id:
          type: string
          description: The custom stop property id
        name:
          type: string
          description: The name of the custom stop property
        visibleToDrivers:
          type: boolean
          description: Whether this custom stop property is visible to drivers.
        visibleToRecipients:
          type: boolean
          description: Whether this property is visible to recipients.
      required:
      - id
      - name
      - visibleToDrivers
      - visibleToRecipients
      additionalProperties: false
      description: The definition of a custom stop property.
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: Use the API key as the username and leave the password empty.