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

# List this partner's sponsored seats

> Return a keyset-paginated, partner-scoped roster (newest first).



## OpenAPI

````yaml /api-reference/openapi.json get /v1/partners/sponsorships
openapi: 3.1.0
info:
  title: DSS Public API
  description: >-
    Public OAuth 2.0 API for Digital Sea Service. See
    https://docs.digitalseaservice.com for the developer guide.
  version: 1.0.0
  contact:
    name: DSS Developer Support
    email: admin@digitalseaservice.com
    url: https://docs.digitalseaservice.com
  license:
    name: Proprietary
  termsOfService: https://digitalseaservice.com/terms
servers:
  - url: https://api.digitalseaservice.com
    description: Production
  - url: https://api.dev.digitalseaservice.com
    description: Sandbox (dev)
security: []
paths:
  /v1/partners/sponsorships:
    get:
      tags:
        - partners
      summary: List this partner's sponsored seats
      description: Return a keyset-paginated, partner-scoped roster (newest first).
      operationId: list_sponsorships_v1_partners_sponsorships_get
      parameters:
        - name: status
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Filter by status.
            title: Status
          description: Filter by status.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 200
            minimum: 1
            description: Page size (max 200).
            default: 50
            title: Limit
          description: Page size (max 200).
        - name: cursor
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Opaque cursor from a prior page.
            title: Cursor
          description: Opaque cursor from a prior page.
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SponsorshipList'
        '401':
          description: >-
            `invalid_token` — bearer token missing, malformed, expired, or
            revoked.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: '`insufficient_scope` — the token lacks the required scope.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '422':
          description: >-
            `invalid_request` — request validation failed; see the `errors`
            array.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
        '429':
          description: '`rate_limit_exceeded` — per-client request budget exhausted.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '500':
          description: >-
            `internal_error` — an unexpected error occurred; reference
            `instance`.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      security:
        - oauth2:
            - profile:read
        - bearerAuth: []
components:
  schemas:
    SponsorshipList:
      properties:
        items:
          items:
            $ref: '#/components/schemas/SponsorshipItem'
          type: array
          title: Items
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Cursor
      type: object
      required:
        - items
      title: SponsorshipList
      description: A page of sponsorships plus the opaque cursor for the next page.
      example:
        items:
          - activated_at: '2026-07-04T10:30:00Z'
            crew_name: Jane Doe
            email: jane@example.com
            expires_at: '2027-07-04T10:30:00Z'
            external_ref: ywc-beta-0042
            invited_at: '2026-07-03T09:00:00Z'
            sponsorship_id: 665f00000000000000000042
            status: active
    ProblemDetails:
      type: object
      description: >-
        RFC 7807 Problem Details. Returned with the `application/problem+json`
        content type on every resource (`/v1/*`) error.
      properties:
        type:
          type: string
          format: uri
          description: Stable URL identifying the error type; resolves to its docs page.
        title:
          type: string
          description: Short, human-readable summary of the error type.
        status:
          type: integer
          description: HTTP status code.
        detail:
          type: string
          description: Explanation specific to this occurrence.
        instance:
          type: string
          description: Request correlation id; matches the `X-Request-Id` header.
      required:
        - type
        - title
        - status
        - detail
        - instance
    ValidationProblemDetails:
      description: Problem Details for a 422, carrying a per-field `errors` array.
      allOf:
        - $ref: '#/components/schemas/ProblemDetails'
        - type: object
          properties:
            errors:
              type: array
              description: One entry per field that failed validation.
              items:
                type: object
                additionalProperties: true
    SponsorshipItem:
      properties:
        sponsorship_id:
          type: string
          title: Sponsorship Id
        email:
          type: string
          title: Email
        crew_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Crew Name
        status:
          type: string
          title: Status
        user_id:
          anyOf:
            - type: string
            - type: 'null'
          title: User Id
          description: >-
            The member's DSS user id — the same id delivered in
            ``user.sea_time.updated`` webhooks. Null until the seat is active.
        external_ref:
          anyOf:
            - type: string
            - type: 'null'
          title: External Ref
        invited_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Invited At
        activated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Activated At
        expires_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Expires At
      type: object
      required:
        - sponsorship_id
        - email
        - status
      title: SponsorshipItem
      description: Public projection of one sponsored seat — no token hash, no Stripe ids.
      example:
        activated_at: '2026-07-04T10:30:00Z'
        crew_name: Jane Doe
        email: jane@example.com
        expires_at: '2027-07-04T10:30:00Z'
        external_ref: ywc-beta-0042
        invited_at: '2026-07-03T09:00:00Z'
        sponsorship_id: 665f00000000000000000042
        status: active
  securitySchemes:
    oauth2:
      type: oauth2
      description: >-
        OAuth 2.0 Authorization Code flow with PKCE. See the integration guide
        at docs.digitalseaservice.com for the full step-by-step.
      flows:
        authorizationCode:
          authorizationUrl: https://api.digitalseaservice.com/oauth/authorize
          tokenUrl: https://api.digitalseaservice.com/oauth/token
          refreshUrl: https://api.digitalseaservice.com/oauth/token
          scopes:
            profile:read: Read the crew member's name, role, country, and photo URL.
            seatime:read: Read aggregate sea-time totals and the 12-month trend.
            vessels:read: Read the crew member's vessel history.
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Opaque

````