Microsoft Lists API

openapi: 3.2.0
info:
  title: Microsoft SharePoint REST Lists API
  description: REST service for remotely interacting with SharePoint data including sites, lists, list items, and document libraries using standard REST and OData protocols.
  version: '1.0'
  contact:
    name: SharePoint Developer Support
    url: https://learn.microsoft.com/en-us/sharepoint/dev/
  termsOfService: https://www.microsoft.com/en-us/legal/terms-of-use
servers:
- url: https://{tenant}.sharepoint.com/_api
  description: SharePoint REST API
  variables:
    tenant:
      default: your-tenant
      description: Your SharePoint Online tenant name
security:
- oauth2: []
tags:
- name: Lists
  description: Manage SharePoint lists
paths:
  /web/lists:
    get:
      operationId: listLists
      summary: Microsoft List all lists
      description: Get all lists in the current SharePoint site.
      tags:
      - Lists
      responses:
        '200':
          description: List of SharePoint lists
          content:
            application/json:
              schema:
                type: object
                properties:
                  d:
                    type: object
                    properties:
                      results:
                        type: array
                        items:
                          $ref: '#/components/schemas/SPList'
        '401':
          description: Unauthorized
  /web/lists/getbytitle('{listTitle}'):
    get:
      operationId: getListByTitle
      summary: Microsoft Get list by title
      description: Get a SharePoint list by its title.
      tags:
      - Lists
      parameters:
      - name: listTitle
        in: path
        required: true
        description: Title of the list
        schema:
          type: string
      responses:
        '200':
          description: List details
          content:
            application/json:
              schema:
                type: object
                properties:
                  d:
                    $ref: '#/components/schemas/SPList'
        '401':
          description: Unauthorized
        '404':
          description: List not found
components:
  schemas:
    SPList:
      type: object
      properties:
        Id:
          type: string
        Title:
          type: string
          description: Title of the list
        Description:
          type: string
        ItemCount:
          type: integer
          description: Number of items in the list
        Created:
          type: string
          format: date-time
        LastItemModifiedDate:
          type: string
          format: date-time
        Hidden:
          type: boolean
        BaseTemplate:
          type: integer
          description: List template type
        ListItemEntityTypeFullName:
          type: string
  securitySchemes:
    oauth2:
      type: oauth2
      description: Microsoft Entra ID OAuth 2.0
      flows:
        authorizationCode:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
          tokenUrl: https://login.microsoftonline.com/common/oauth2/v2.0/token
          scopes:
            Sites.Read.All: Read items in all site collections
            Sites.ReadWrite.All: Read and write items in all site collections
externalDocs:
  description: SharePoint REST API Documentation
  url: https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/get-to-know-the-sharepoint-rest-service