Scispot Scispot API - LOCATIONS API

The Scispot API - LOCATIONS API API from Scispot — 4 operation(s) for scispot api - locations api.

GitHub OpenAPI

Operations 4

GET /location/list Fetch Root Locations #
GET /location/list-sublocations-by-id Fetch Sub Locations by Location Id #
POST /location/create Create Locations in Bulk #
GET /location/create/status Get Create Location 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/scispot:scispot-scispot-api-locations-api-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

scispot-scispot-api-locations-api-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Scispot's API Documentation Scispot API - LOCATIONS API
  description: '### Welcome! Feel Free To Visit Scispot.com


    #### Overview


    This is a documentation listing API calls for the following Scispot applications:


    1. Labsheets (LIMS)


    2. ELN


    3. Manifests (plates, boxes, racks, etc.)


    4. Sequences


    ## Getting Started


    ### Create a new API Key in account settings


    - Go to Scispot


    - Click on the "Account" button in the navigation bar on the bottom left corner of your screen


    - Click "Personal Tokens" on the left side of the pop-up modal


    - Click "Generate New Token"


    - Name your token, select token access, and click "Generate"


    - Copy the API Key and save it somewhere safe - this token cannot be retrieved once it is generated


    - This token will be used as "apiKey" in all API requests'
  version: 1.0.0
servers:
- url: https://cloudlab.scispot.io
  description: Scispot Cloud Lab
security:
- bearerAuth: []
tags:
- name: Scispot API - LOCATIONS API
paths:
  /location/list:
    get:
      tags:
      - Scispot API - LOCATIONS API
      summary: Fetch Root Locations
      description: Retrieve list of all root locations.
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  locations:
                    type: array
                    items:
                      type: object
                      properties:
                        uuid:
                          type: string
                        name:
                          type: string
                        type:
                          type: string
                      additionalProperties: true
                additionalProperties: true
              example:
                success: true
                locations:
                - uuid: <uuid>
                  name: Lab Room 1
                  type: ROOM
        '401':
          description: Invalid Authentication Token
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                additionalProperties: true
              example:
                success: false
                message: Invalid Authentication Token
        '403':
          description: Missing Authentication Token
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                additionalProperties: true
              example:
                success: false
                message: Missing Authentication Token
        '500':
          description: Operation failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                additionalProperties: true
              example:
                success: false
                message: Operation failed
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                additionalProperties: true
              example:
                success: false
                message: Bad request
      parameters: []
      operationId: getLocationList
      x-operation-id-source: derived
  /location/list-sublocations-by-id:
    get:
      tags:
      - Scispot API - LOCATIONS API
      summary: Fetch Sub Locations by Location Id
      description: Given a **parent location UUID**, lists everything directly inside—child locations, storage racks, manifests (plates), and sample inventory rows.
      parameters:
      - name: uuid
        in: query
        schema:
          type: string
          example: <uuid>
        description: parent location to drill down into.
        required: true
      responses:
        '200':
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  sublocations:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
                  racks:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
                  manifests:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
                  samples:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
                additionalProperties: true
              example:
                success: true
                sublocations:
                - uuid: <uuid>
                  name: Freezer A
                  type: FREEZER
                racks: []
                manifests:
                - name: Sample Plate
                  hrid: PLT000001
                  uuid: <uuid>
                samples:
                - id: SMPL000001
                  labsheet: Sample Manager
          description: OK
        '401':
          description: Invalid Authentication Token
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                additionalProperties: true
              example:
                success: false
                message: Invalid Authentication Token
        '403':
          description: Missing Authentication Token
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                additionalProperties: true
              example:
                success: false
                message: Missing Authentication Token
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                additionalProperties: true
              example:
                success: false
                message: Validation error
        '500':
          description: Operation failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                additionalProperties: true
              example:
                success: false
                message: Operation failed
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                additionalProperties: true
              example:
                success: false
                message: Bad request
      operationId: getLocationListSublocationsById
      x-operation-id-source: derived
  /location/create:
    post:
      tags:
      - Scispot API - LOCATIONS API
      summary: Create Locations in Bulk
      description: 'This API endpoint is used to create single locations or locations in bulk. This is an async process, so the return message will only return the request ID for the async ticket. In order to check the creation status of this endpoint, use the /location/create/status endpoint with the request ID as the parameter.


        Location Types supported by this endpoint includes


        - Room


        - Shelf


        - Freezer


        - Custom locations


        Location Types that are not currently supported via this API


        - Racks


        - Manifest (Use the "Assign Manifest To A Location" endpoint to assign manifest locations)


        There is a heirarchy for these locations where some location types cannot be created as a child of another location type.


        Root Locations: Rooms, Shelves, Freezers, Custom Locations


        Within Rooms: Freezers, Shelves, Custom Locations


        Within Freezers: Shelves, Custom Locations


        Within Shelves: Custom Locations


        Within Custom Locations: Shelves, Custom Locations


        Creates up to 20 location nodes including children. Maximum nested depth is 3. RACK cannot be created through this endpoint. FREEZER requires temperature and temperatureUnit; CUSTOM requires customTypeName.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                locations:
                  type: array
                  description: The location nodes to create. Counts include nested children, up to a maximum of 20 nodes per request with a maximum nesting depth of 3.
                  items:
                    type: object
                    properties:
                      name:
                        type: string
                        description: The name of the location. Allowed characters are letters, numbers, spaces, and ._()-/,& (pattern ^[a-zA-Z0-9 ._()\-/,&]+$).
                      locationType:
                        type: string
                        description: 'The type of location. One of: ROOM, FREEZER, SHELF, CUSTOM. RACK is not supported through this endpoint. Hierarchy rules apply (e.g. FREEZER may only be nested under ROOM).'
                      idRef:
                        type: string
                        description: (Optional) The UUID of an existing parent location to create this location under. Omit for a root location.
                      children:
                        type: array
                        description: (Optional) Nested child locations, each following this same shape. Nesting is allowed up to 3 levels deep.
                        items:
                          type: object
                          additionalProperties: true
                      temperature:
                        type: string
                        description: The temperature of the freezer. Required when locationType is FREEZER; must be omitted otherwise.
                      temperatureUnit:
                        type: string
                        description: The unit for `temperature` (e.g. C or F). Required when locationType is FREEZER; must be omitted otherwise.
                      customTypeName:
                        type: string
                        description: The display name of the custom location type. Required when locationType is CUSTOM; must be omitted otherwise.
                    required:
                    - name
                    - locationType
                    additionalProperties: true
                  maxItems: 20
              required:
              - locations
              additionalProperties: true
            example:
              locations:
              - name: Lab Room 1
                locationType: ROOM
                children:
                - name: Freezer A
                  locationType: FREEZER
                  temperature: '-80'
                  temperatureUnit: C
                  children:
                  - name: Shelf 1
                    locationType: SHELF
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  requestId:
                    type: string
                  message:
                    type: string
                additionalProperties: true
              example:
                success: true
                requestId: <requestId>
                message: Location creation queued
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
        '401':
          description: Invalid Authentication Token
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                additionalProperties: true
              example:
                success: false
                message: Invalid Authentication Token
        '403':
          description: Missing Authentication Token
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                additionalProperties: true
              example:
                success: false
                message: Missing Authentication Token
        '500':
          description: Operation failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                additionalProperties: true
              example:
                success: false
                message: Operation failed
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                additionalProperties: true
              example:
                success: false
                message: Bad request
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                additionalProperties: true
              example:
                success: false
                message: Validation error
      parameters: []
      operationId: postLocationCreate
      x-operation-id-source: derived
  /location/create/status:
    get:
      tags:
      - Scispot API - LOCATIONS API
      summary: Get Create Location Status
      description: 'This endpoint is used in conjunction with the location/create endpoint that creates locations in an async manner. This endpoint is used to check the status of the async request created by the location/create endpoint.


        To use this endpoint, add the requestId to the params when calling this endpoint, and a response will be returned with the status of the create location request. with the status, and result of the create location request.'
      parameters:
      - name: requestId
        in: query
        schema:
          type: string
        description: 'This is the request id from the response of the location/create endpoint. '
        example: <requestId>
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  requestId:
                    type: string
                  status:
                    type: string
                  message:
                    type: string
                  result:
                    type: object
                    additionalProperties: true
                additionalProperties: true
              example:
                success: true
                requestId: <requestId>
                status: COMPLETED
                message: Locations created successfully
                result:
                  created:
                  - name: Lab Room 1
                    uuid: <uuid>
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
        '401':
          description: Invalid Authentication Token
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                additionalProperties: true
              example:
                success: false
                message: Invalid Authentication Token
        '403':
          description: Missing Authentication Token
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                additionalProperties: true
              example:
                success: false
                message: Missing Authentication Token
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                additionalProperties: true
              example:
                success: false
                message: Validation error
        '500':
          description: Operation failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                additionalProperties: true
              example:
                success: false
                message: Operation failed
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                additionalProperties: true
              example:
                success: false
                message: Bad request
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                additionalProperties: true
              example:
                success: false
                message: Not found
      operationId: getLocationCreateStatus
      x-operation-id-source: derived
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: UUID
      description: Personal access token from Scispot Account → Personal Tokens