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

# List members

> Owner, members with shared access and pending invitations.

**Permission:** `services.members.read`



## OpenAPI

````yaml /docs/service-api.yaml get /services/{service}/members
openapi: 3.1.0
info:
  title: Spartan Service API
  version: '2026.11'
  description: >-
    Services: create, read and update, lifecycle actions, billing and pricing,
    plan changes, notes, members, addons, provider details and dispute evidence.


    All requests need an API key from **Admin, API** in the `Authorization:
    Bearer <key>` header. Replace `{domain}` with the domain of your Spartan
    installation. Successful responses use the envelope `{"data": ..., "meta":
    {"request_id": ...}}`; errors use `{"error": {"code", "message", "details"},
    "request_id"}`.
servers:
  - url: https://{domain}/api/application
    description: Your Spartan installation
    variables:
      domain:
        default: billing.example.com
        description: Domain of your Spartan installation, without https://
security:
  - bearerAuth: []
tags:
  - name: Services
  - name: Lifecycle
  - name: Billing
  - name: Upgrades
  - name: Notes
  - name: Members
  - name: Addons
  - name: Service details
  - name: Evidence
paths:
  /services/{service}/members:
    get:
      tags:
        - Members
      summary: List members
      description: |-
        Owner, members with shared access and pending invitations.

        **Permission:** `services.members.read`
      operationId: listServiceMembers
      parameters:
        - name: service
          in: path
          required: true
          description: Service id.
          schema:
            type: integer
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ServiceMembers'
                  meta:
                    $ref: '#/components/schemas/Meta'
                required:
                  - data
                  - meta
              example:
                data:
                  owner:
                    id: 192
                    name: Jane A. Cooper
                    email: jane.cooper@example.com
                    avatar: /assets/default-avatar.png
                  members:
                    - email: liam.walker@example.com
                      permission_level: friends
                      permissions:
                        - /analytics
                        - /shell
                      invited_at: '2026-11-16T14:33:50.146790Z'
                      user:
                        id: 193
                        name: Liam Walker
                        email: liam.walker@example.com
                        avatar: /assets/default-avatar.png
                  pending_invitations:
                    - id: 9
                      email: new.teammate@example.com
                      permission_level: custom
                      permissions:
                        - view_details
                        - power_actions
                      expires_at: '2026-11-23T14:33:50.000000Z'
                meta:
                  request_id: ea82fdb5-7cec-4cef-8681-351fc0cd85ce
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    ServiceMembers:
      type: object
      properties:
        owner:
          $ref: '#/components/schemas/UserReference'
        members:
          type: array
          items:
            $ref: '#/components/schemas/ServiceMember'
        pending_invitations:
          type: array
          items:
            $ref: '#/components/schemas/ServiceInvitation'
    Meta:
      type: object
      properties:
        request_id:
          type: string
          format: uuid
          description: Request id, also sent in the `X-Request-ID` response header.
      required:
        - request_id
    UserReference:
      type: object
      properties:
        id:
          type: integer
          description: User id.
        name:
          type: string
          description: Display name.
        email:
          type: string
          format: email
          description: Email address.
        avatar:
          type:
            - string
            - 'null'
          description: Avatar path or URL.
    ServiceMember:
      type: object
      properties:
        email:
          type: string
          format: email
        permission_level:
          type: string
          enum:
            - friends
            - admin
            - custom
        permissions:
          type: array
          items:
            type: string
          description: Permission keys for `custom` members.
        invited_at:
          type:
            - string
            - 'null'
          format: date-time
        user:
          oneOf:
            - $ref: '#/components/schemas/UserReference'
            - type: 'null'
    ServiceInvitation:
      type: object
      properties:
        id:
          type: integer
          description: Invitation id.
        email:
          type: string
          format: email
        permission_level:
          type: string
          enum:
            - friends
            - admin
            - custom
        permissions:
          type: array
          items:
            type: string
        expires_at:
          type:
            - string
            - 'null'
          format: date-time
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: >-
                Machine readable error code, for example `unauthorized`,
                `forbidden`, `not_found`, `invalid_service_state`.
            message:
              type: string
              description: Human readable explanation.
            details:
              type: object
              properties: {}
              description: Extra context. An empty object for most errors.
              additionalProperties: true
          required:
            - code
            - message
            - details
        request_id:
          type: string
          format: uuid
          description: >-
            Request id. Also returned in the `X-Request-ID` header. Send your
            own with `X-Request-ID` to correlate logs.
      description: Error envelope returned by every failed request.
      required:
        - error
        - request_id
  responses:
    Unauthorized:
      description: Missing, invalid or inactive API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            missing:
              summary: No Authorization header
              value:
                error:
                  code: unauthorized
                  message: Bearer token required.
                  details: {}
                request_id: 9aca26ca-e06f-4725-8e4b-4385d6c03422
            invalid:
              summary: Unknown or inactive key
              value:
                error:
                  code: unauthorized
                  message: Invalid or inactive token.
                  details: {}
                request_id: 8802a669-6f06-453e-a1d8-0b81621167c3
    Forbidden:
      description: >-
        The key lacks the permission for this endpoint, or the request IP is not
        in the key allow list.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            forbidden:
              summary: Missing permission
              value:
                error:
                  code: forbidden
                  message: Insufficient permissions for this action.
                  details: {}
                request_id: 191c51e1-03a3-448e-8df7-3c584be888b0
            ip_not_allowed:
              summary: IP not allowed
              value:
                error:
                  code: ip_not_allowed
                  message: Access denied from this IP address.
                  details: {}
                request_id: 3f6c2a1e-8b4d-4f7a-9c2e-5d1b7a9e0c42
    NotFound:
      description: The resource in the path does not exist.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: not_found
              message: The requested resource was not found.
              details: {}
            request_id: cccbc627-4fd4-4727-889e-fa727c48792c
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key created in Admin, API. Send it as `Authorization: Bearer <key>`.
        Each key has its own permissions and optional IP allow list.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.