> ## Documentation Index
> Fetch the complete documentation index at: https://docs.saturnshift.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List merchants

> Returns your institution's merchants, newest first. Use this to map your merchant records to SaturnShift merchant ids.



## OpenAPI

````yaml /openapi.json get /v1/merchants
openapi: 3.0.3
info:
  title: SaturnShift Partner API
  version: 1.0.0
  description: >-
    Server-to-server API for partner PSPs to authenticate, read native crypto
    transactions and merchants, and receive webhooks. All endpoints are scoped
    to the authenticated institution.
servers:
  - url: https://api.saturnshift.io
    description: Production
security: []
tags:
  - name: Authentication
    description: OAuth2 client credentials.
  - name: Transactions
    description: Read native crypto transactions.
  - name: Merchants
    description: Read your merchants.
paths:
  /v1/merchants:
    get:
      tags:
        - Merchants
      summary: List merchants
      description: >-
        Returns your institution's merchants, newest first. Use this to map your
        merchant records to SaturnShift merchant ids.
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            default: 25
            minimum: 1
            maximum: 100
        - name: starting_after
          in: query
          schema:
            type: integer
      responses:
        '200':
          description: A list of merchants
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MerchantList'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      security:
        - oauth2:
            - merchants:read
components:
  schemas:
    MerchantList:
      type: object
      properties:
        object:
          type: string
          example: list
        data:
          type: array
          items:
            $ref: '#/components/schemas/Merchant'
        has_more:
          type: boolean
          example: false
        next_cursor:
          type: integer
          nullable: true
          example: null
    Merchant:
      type: object
      properties:
        object:
          type: string
          example: merchant
        id:
          type: integer
          example: 116
        name:
          type: string
          nullable: true
          example: Green Leaf Coffee
        legal_name:
          type: string
          nullable: true
        email:
          type: string
          nullable: true
          example: owner@greenleaf.example
        status:
          type: string
          nullable: true
          example: ACTIVE
        onboarding_status:
          type: string
          nullable: true
          example: ACTIVE
        crypto_enabled:
          type: boolean
          example: true
        onboarding_complete:
          type: boolean
          example: true
        created_at:
          type: string
          format: date-time
          nullable: true
    OAuthError:
      type: object
      properties:
        error:
          type: string
          example: invalid_client
        error_description:
          type: string
          nullable: true
  responses:
    Unauthorized:
      description: Missing or invalid bearer token
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OAuthError'
    Forbidden:
      description: Token is missing the required scope
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OAuthError'
  securitySchemes:
    oauth2:
      type: oauth2
      description: >-
        OAuth2 client credentials. Request a token from /oauth/token and send it
        as `Authorization: Bearer <token>`.
      flows:
        clientCredentials:
          tokenUrl: https://api.saturnshift.io/oauth/token
          scopes:
            transactions:read: Read transactions
            merchants:read: Read merchants

````