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

# Get Sending connection

> Validate this Sending credential and return its team, connection label, permissions and authorised mailboxes. Requires email.send. Credits, provider readiness and mailbox storage are not checked. No user profile or secrets are returned.



## OpenAPI

````yaml /openapi-sending.json get /me
openapi: 3.1.0
info:
  description: >-
    Send emails programmatically via the Sendmux email infrastructure. Every
    response carries an `X-Request-Id` header; errors include a `retryable`
    flag. 429 and 503 responses include `Retry-After`. Mutating endpoints accept
    an `Idempotency-Key` header for safe retries.
  title: Sendmux Sending API
  version: 1.0.0
servers:
  - description: Production
    url: https://smtp.sendmux.ai/api/v1
security:
  - BearerAuth: []
  - OAuth2:
      - email.send
paths:
  /me:
    get:
      tags:
        - Meta
      summary: Get Sending connection
      description: >-
        Validate this Sending credential and return its team, connection label,
        permissions and authorised mailboxes. Requires email.send. Credits,
        provider readiness and mailbox storage are not checked. No user profile
        or secrets are returned.
      operationId: sendingGetConnection
      parameters:
        - description: >-
            Weak ETag from a previous response. When it matches the current
            resource, the server returns 304 Not Modified with no body.
          in: header
          name: If-None-Match
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionResponse'
          description: Connection information
          headers:
            Cache-Control:
              description: Always no-store.
              schema:
                type: string
            ETag:
              schema:
                type: string
            X-Request-Id:
              description: Request identifier.
              schema:
                type: string
        '304':
          description: >-
            Connection information is unchanged. Authentication is checked on
            every request.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Authentication required
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Credential is not authorised for this API
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Rate limit exceeded
          headers:
            Retry-After:
              schema:
                type: string
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Authentication service temporarily unavailable
          headers:
            Retry-After:
              schema:
                type: string
      security:
        - BearerAuth: []
        - OAuth2:
            - email.send
components:
  schemas:
    ConnectionResponse:
      allOf:
        - $ref: '#/components/schemas/SuccessEnvelope'
        - properties:
            data:
              $ref: '#/components/schemas/Connection'
          required:
            - data
          type: object
      unevaluatedProperties: false
    ErrorResponse:
      additionalProperties: false
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
        meta:
          $ref: '#/components/schemas/Meta'
        ok:
          enum:
            - false
          type: boolean
      required:
        - ok
        - error
        - meta
      type: object
    SuccessEnvelope:
      properties:
        meta:
          $ref: '#/components/schemas/Meta'
        ok:
          enum:
            - true
          type: boolean
      required:
        - ok
        - meta
      type: object
    Connection:
      additionalProperties: false
      properties:
        credential:
          additionalProperties: false
          properties:
            id:
              type: string
            name:
              type:
                - string
                - 'null'
            type:
              enum:
                - api_key
                - oauth
                - agent_token
              example: api_key
              type: string
          required:
            - id
            - type
            - name
          type: object
        label:
          description: Display label for this connection.
          type: string
        mailboxes:
          items:
            additionalProperties: false
            properties:
              email:
                format: email
                type: string
              id:
                type: string
            required:
              - id
              - email
            type: object
          type: array
        permissions:
          items:
            type: string
          type: array
        team:
          additionalProperties: false
          properties:
            id:
              type: string
            name:
              type: string
          required:
            - id
            - name
          type: object
      required:
        - team
        - credential
        - label
        - permissions
        - mailboxes
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        code:
          description: Machine-readable error code
          example: validation_error
          type: string
        doc_url:
          description: Link to error documentation
          format: uri
          type: string
        errors:
          description: Accumulated per-field issues (validation errors)
          items:
            $ref: '#/components/schemas/ErrorIssue'
          type: array
        message:
          description: Human-readable error description
          type: string
        param:
          description: Parameter that caused the error
          type: string
        retryable:
          description: >-
            True when the client may safely retry the same request. 429 and 5xx
            default true; 4xx default false.
          type: boolean
      required:
        - code
        - message
        - retryable
      type: object
    Meta:
      additionalProperties: false
      properties:
        request_id:
          description: Unique request identifier
          example: req_clxxxxxxxxxxxxxxxxxxxxxxxxx
          type: string
      required:
        - request_id
      type: object
    ErrorIssue:
      additionalProperties: false
      properties:
        code:
          description: Issue code from the validator
          example: invalid_string
          type: string
        field:
          description: Dot-path to the failing field
          example: to.email
          type: string
        message:
          description: Human-readable issue message
          type: string
      required:
        - field
        - code
        - message
      type: object
  securitySchemes:
    BearerAuth:
      description: Sendmux API key (smx_...)
      scheme: bearer
      type: http
    OAuth2:
      description: >-
        Use the authorisation-code flow with S256 PKCE and
        resource=https://sendmux.ai/api. The user must grant Sending API access
        and email.send. OAuth access tokens authenticate HTTP requests; use a
        send-capable API key for SMTP.
      flows:
        authorizationCode:
          authorizationUrl: https://app.sendmux.ai/oauth/authorize
          refreshUrl: https://app.sendmux.ai/oauth/token
          scopes:
            email.send: Send email and manage temporary sending attachments
          tokenUrl: https://app.sendmux.ai/oauth/token
      type: oauth2

````