Locus

Locus HomebaseMaster API

The HomebaseMaster API from Locus — 2 operation(s) for homebasemaster.

Documentation GitHub OpenAPI

Operations 3

GET /client/{clientId}/homebase-master/{homebaseId} Get a homebase #

PUT /client/{clientId}/homebase-master/{homebaseId} Create a homebase #

POST /client/{clientId}/homebase-master/{homebaseId}/status #

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/locus-sh-homebasemaster-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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Locus Homebase Master API
  description: Manage your deliveries with the Locus API
  version: 1.0.0
servers:
- url: https://oms.locus-api.com/v1
tags:
- name: HomebaseMaster
paths:
  /client/{clientId}/homebase-master/{homebaseId}:
    parameters:
    - $ref: '#/components/parameters/ClientIdParam'
    - $ref: '#/components/parameters/HomebaseIdParam'
    get:
      summary: Get a homebase
      operationId: getHomebase
      parameters:
      - name: include
        in: query
        description: Comma separated list of extra fields that should be returned. Supported values are CONTACT.
        schema:
          type: string
      tags:
      - HomebaseMaster
      responses:
        '200':
          description: Homebase object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Homebase'
      security:
      - locusauth: []
    put:
      summary: Create a homebase
      operationId: createHomebase
      parameters:
      - $ref: '#/components/parameters/OverwriteParam'
      tags:
      - HomebaseMaster
      responses:
        '200':
          description: Created homebase
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Homebase'
      security:
      - locusauth: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Homebase'
        description: Create homebase request
        required: true
  /client/{clientId}/homebase-master/{homebaseId}/status:
    parameters:
    - $ref: '#/components/parameters/ClientIdParam'
    - $ref: '#/components/parameters/HomebaseIdParam'
    post:
      description: Update status for a specific homebase
      operationId: updateHomebaseStatus
      tags:
      - HomebaseMaster
      responses:
        '200':
          description: Updated homebases
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Homebase'
      security:
      - locusauth: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EntityStatusUpdateRequest'
        description: Updated status of homebase
        required: true
components:
  schemas:
    EntityStatusUpdateRequest:
      $ref: https://swagger.locus-api.com/common-entities.yaml#/definitions/EntityStatusUpdateRequest
    Homebase:
      $ref: https://swagger.locus-api.com/common-entities.yaml#/definitions/Homebase
  parameters:
    ClientIdParam:
      name: clientId
      in: path
      description: Id of the client
      required: true
      schema:
        type: string
    OverwriteParam:
      name: overwrite
      in: query
      description: Boolean flag if true, will overwrite the existing entity
      required: false
      schema:
        type: boolean
    HomebaseIdParam:
      name: homebaseId
      in: path
      description: Id of homebase
      required: true
      schema:
        type: string
  securitySchemes:
    locusauth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization