Locus

Locus Roster API

The Roster API from Locus — 3 operation(s) for roster.

Documentation GitHub OpenAPI

Operations 3

GET /client/{clientId}/roster/{rosterId} Get Roster by Id #

POST /client/{clientId}/rosters-auto-create API Bulk create rosters for api integrated clients #

POST /client/{clientId}/roster/{rosterId}/disable #

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-roster-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 HomebaseMaster Roster API
  description: Manage your deliveries with the Locus API
  version: 1.0.0
servers:
- url: https://oms.locus-api.com/v1
tags:
- name: Roster
paths:
  /client/{clientId}/roster/{rosterId}:
    parameters:
    - $ref: '#/components/parameters/ClientIdParam'
    - $ref: '#/components/parameters/RosterIdParam'
    get:
      summary: Get Roster by Id
      operationId: getRoster
      parameters:
      - name: include
        in: query
        description: Comma separated list of extra fields that should be returned. Supported values are RESOURCES.
        required: false
        schema:
          type: string
      tags:
      - Roster
      responses:
        '200':
          description: GetRosterResponse Object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRosterResponse'
      security:
      - locusauth: []
  /client/{clientId}/rosters-auto-create:
    parameters:
    - $ref: '#/components/parameters/ClientIdParam'
    - $ref: '#/components/parameters/OverwriteParam'
    post:
      summary: API Bulk create rosters for api integrated clients
      operationId: createRostersApiRequest
      tags:
      - Roster
      responses:
        '200':
          description: API Bulk create rosters response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateRosterResponse'
      security:
      - locusauth: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRostersApiRequest'
        description: Request body for api Integrated clients
        required: true
  /client/{clientId}/roster/{rosterId}/disable:
    parameters:
    - $ref: '#/components/parameters/ClientIdParam'
    - $ref: '#/components/parameters/RosterIdParam'
    post:
      description: Disable a specific roster
      operationId: disableRoster
      tags:
      - Roster
      responses:
        '200':
          description: Updated roster
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Roster'
      security:
      - locusauth: []
components:
  schemas:
    Roster:
      $ref: https://swagger.locus-api.com/roster-entity.yaml#/definitions/Roster
    RosterShiftLocation:
      $ref: https://swagger.locus-api.com/roster-entity.yaml#/definitions/RosterShiftLocation
    VehicleModelId:
      type: object
    GetRosterResponse:
      $ref: https://swagger.locus-api.com/roster-entity.yaml#/definitions/GetRosterResponse
    CreateBreaksApiRequest:
      description: Shift Roster request for bulk create
      required:
      - startTime
      - endTime
      - duration
      - breakType
      properties:
        startTime:
          description: Break Start Time
          type: string
        endTime:
          description: Break End Time
          type: string
        duration:
          description: Duration of break
          type: string
        breakType:
          description: Type of break - LUNCH, REFUEL
          type: string
          enum:
          - LUNCH
          - REFUEL
          - NIGHT
          - OTHER
          default: LUNCH
    RosterEntityType:
      $ref: https://swagger.locus-api.com/roster-entity.yaml#/definitions/RosterEntityType
    CreateRosterShiftApiRequest:
      description: Shift Roster request for bulk create
      required:
      - tagId
      - start
      properties:
        tagId:
          description: Shift Tag Id for the Roster
          type: string
        start:
          $ref: '#/components/schemas/RosterShiftLocation'
        end:
          $ref: '#/components/schemas/RosterShiftLocation'
        breaks:
          type: array
          description: List of Breaks for the Roster
          items:
            $ref: '#/components/schemas/CreateBreaksApiRequest'
    CreateRosterResponse:
      $ref: https://swagger.locus-api.com/roster-entity.yaml#/definitions/CreateRosterResponse
    SkillId:
      $ref: https://swagger.locus-api.com/common-entities.yaml#/definitions/SkillId
    CreateRostersApiRequest:
      description: API Roster request for bulk create
      required:
      - clientId
      - startDate
      - endDate
      - entityType
      - teamId
      - riderIds
      - vehicleIds
      - vehicleModelId
      - daysOff
      - shift
      - applyToAll
      properties:
        clientId:
          type: string
        startDate:
          description: Roster start date in YYYY-MM-DD format. Eg. 2021-11-18
          type: string
        endDate:
          description: Roster end date in YYYY-MM-DD format. Eg. 2021-11-18
          type: string
        entityType:
          description: Entity type for the roster
          $ref: '#/components/schemas/RosterEntityType'
        teamId:
          description: Teams id for Roster Creation
          type: string
        riderIds:
          description: List of Riders
          type: array
          items:
            type: string
        vehicleIds:
          description: List of Vehicles
          type: array
          items:
            type: string
        applyToAll:
          type: boolean
          default: false
        vehicleModelId:
          $ref: '#/components/schemas/VehicleModelId'
        daysOff:
          description: List of Days Off for Roster Creation
          type: array
          items:
            type: string
        shift:
          $ref: '#/components/schemas/CreateRosterShiftApiRequest'
        skills:
          type: array
          items:
            $ref: '#/components/schemas/SkillId'
  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
    RosterIdParam:
      name: rosterId
      in: path
      description: Id of roster
      required: true
      schema:
        type: string
  securitySchemes:
    locusauth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization