Nooks Mailboxes API

openapi: 3.2.0
info:
  title: Nooks Sequencing Mailboxes API
  version: 0.1.0
  description: The Nooks Sequencing API provides programmatic access to manage sequences, tasks, templates, and prospect engagement workflows created using the Nooks SEP.
  contact:
    name: Nooks API Support
    email: support@nooks.in
    url: https://www.nooks.in
  license:
    name: Proprietary
  x-logo:
    url: ./nooks-logo.svg
    altText: Nooks Logo
    href: https://www.nooks.ai
servers:
- url: https://partner-api.nooks.in/v1
  description: Production API
security:
- BearerAuth: []
tags:
- name: Mailboxes
  description: Manage mailboxes (email aliases)
paths:
  /mailboxes:
    get:
      operationId: listMailboxes
      summary: List mailboxes
      description: 'Returns a paginated list of mailboxes (email aliases).


        Example:

        ```bash

        curl -X GET ''https://partner-api.nooks.in/v1/mailboxes?page[size]=50'' \

        -H "Authorization: Bearer nooks-api-..."

        ```


        Filter by user:

        ```bash

        curl -X GET ''https://partner-api.nooks.in/v1/mailboxes?filter[userId]=KKLvN5wQoghWFwUvC75CZ12QM7I3'' \

        -H "Authorization: Bearer nooks-api-..."

        ```'
      tags:
      - Mailboxes
      parameters:
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PageAfter'
      - $ref: '#/components/parameters/PageBefore'
      - name: filter[userId]
        in: query
        description: Filter mailboxes belonging to a specific user (Firebase UID)
        required: false
        schema:
          type: string
          minLength: 1
        example: KKLvN5wQoghWFwUvC75CZ12QM7I3
      - name: include
        in: query
        description: 'Comma-separated relations to expand inline. Valid values: `user`. Max 3.'
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - user
          maxItems: 3
        style: form
        explode: false
        example:
        - user
      - $ref: '#/components/parameters/FilterUpdatedAtGte'
      - $ref: '#/components/parameters/FilterUpdatedAtLt'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Mailbox'
                  links:
                    $ref: '#/components/schemas/PaginationLinks'
              example:
                data:
                - id: bb0e8400-e29b-41d4-a716-446655440040
                  email: jane@acme.com
                  isDefault: true
                  user:
                    id: 660e8400-e29b-41d4-a716-446655440001
                    _href: /v1/users/660e8400-e29b-41d4-a716-446655440001
                  createdAt: '2025-10-01T10:00:00.000Z'
                  updatedAt: '2025-11-15T14:30:00.000Z'
                - id: cc0e8400-e29b-41d4-a716-446655440041
                  email: jane.alt@acme.com
                  isDefault: false
                  user:
                    id: 660e8400-e29b-41d4-a716-446655440001
                    _href: /v1/users/660e8400-e29b-41d4-a716-446655440001
                  createdAt: '2025-10-05T12:00:00.000Z'
                  updatedAt: '2025-11-20T16:00:00.000Z'
                links:
                  first: https://partner-api.nooks.in/v1/mailboxes?page[size]=50
                  prev: null
                  next: https://partner-api.nooks.in/v1/mailboxes?page[size]=50&page[after]=eyJpZCI6ImNjMGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDA0MSIsInYiOjF9
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
  /mailboxes/{id}:
    get:
      operationId: getMailbox
      summary: Get mailbox by ID
      description: 'Returns a single mailbox by its unique identifier.


        Example:

        ```bash

        curl -X GET ''https://partner-api.nooks.in/v1/mailboxes/bb0e8400-e29b-41d4-a716-446655440040'' \

        -H "Authorization: Bearer nooks-api-..."

        ```'
      tags:
      - Mailboxes
      parameters:
      - name: id
        in: path
        required: true
        description: Unique identifier for the mailbox
        schema:
          type: string
          format: uuid
        example: bb0e8400-e29b-41d4-a716-446655440040
      - name: include
        in: query
        description: 'Comma-separated relations to expand inline. Valid values: `user`. Max 3.'
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - user
          maxItems: 3
        style: form
        explode: false
        example:
        - user
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Mailbox'
              example:
                id: bb0e8400-e29b-41d4-a716-446655440040
                email: jane@acme.com
                isDefault: true
                user:
                  id: 660e8400-e29b-41d4-a716-446655440001
                  _href: /v1/users/660e8400-e29b-41d4-a716-446655440001
                createdAt: '2025-10-01T10:00:00.000Z'
                updatedAt: '2025-11-15T14:30:00.000Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  responses:
    Unauthorized:
      description: Unauthorized - invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHORIZED
              message: Invalid or missing API key
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: NOT_FOUND
              message: The requested resource was not found
    BadRequest:
      description: Bad request - invalid parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: BAD_REQUEST
              message: Invalid page[after] cursor
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INTERNAL_ERROR
              message: An unexpected error occurred
  parameters:
    PageSize:
      name: page[size]
      in: query
      description: Number of items per page (max 100)
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 50
      example: 50
    FilterUpdatedAtLt:
      name: filter[updatedAt][lt]
      in: query
      description: Filter by updatedAt before this timestamp, exclusive (ISO 8601 datetime)
      required: false
      schema:
        type: string
        format: date-time
      example: '2026-01-01T00:00:00Z'
    PageAfter:
      name: page[after]
      in: query
      description: 'Cursor for fetching the next page. Opaque token returned by the

        API in `links.next`; callers should treat it as opaque and only

        pass values they received from a previous response. Malformed

        cursors return `400 Bad Request`.

        '
      required: false
      schema:
        type: string
      example: eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCIsInYiOjF9
    FilterUpdatedAtGte:
      name: filter[updatedAt][gte]
      in: query
      description: Filter by minimum updatedAt (ISO 8601 datetime)
      required: false
      schema:
        type: string
        format: date-time
      example: '2025-01-01T00:00:00Z'
    PageBefore:
      name: page[before]
      in: query
      description: 'Cursor for fetching the previous page. Opaque token returned by

        the API in `links.prev`; callers should treat it as opaque and

        only pass values they received from a previous response.

        Malformed cursors return `400 Bad Request`.

        '
      required: false
      schema:
        type: string
      example: eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCIsInYiOjF9
  schemas:
    PaginationLinks:
      type: object
      description: 'Pagination links for navigating through results.

        Links are returned as relative references (path + query) that

        should be resolved against the base URL of the request.

        '
      properties:
        first:
          type: string
          format: uri-reference
          description: URL for the first page
          example: /v1/sequences?page[size]=50
        prev:
          type: string
          format: uri-reference
          nullable: true
          description: URL for the previous page (null if on first page)
          example: null
        next:
          type: string
          format: uri-reference
          nullable: true
          description: URL for the next page (null if on last page)
          example: /v1/sequences?page[size]=50&page[after]=eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCIsInYiOjF9
    Error:
      type: object
      description: Standard error response
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Error code
              example: NOT_FOUND
            message:
              type: string
              description: Human-readable error message
              example: The requested resource was not found
        traceId:
          type: string
          description: 'Request trace identifier for correlating this error with server

            logs and support requests. Present whenever the request carried a

            trace context (the normal case); omitted otherwise.

            '
          example: abc123def456
    Mailbox:
      type: object
      description: An email mailbox (alias)
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the mailbox
          example: bb0e8400-e29b-41d4-a716-446655440040
        email:
          type: string
          format: email
          description: Email address of the mailbox
          example: jane@acme.com
        isDefault:
          type: boolean
          description: Whether this is the user's default mailbox
          example: true
        user:
          $ref: '#/components/schemas/ReferenceObject'
        createdAt:
          type: string
          format: date-time
          description: When the mailbox was created
          example: '2025-10-01T10:00:00.000Z'
        updatedAt:
          type: string
          format: date-time
          description: When the mailbox was last updated
          example: '2025-11-15T14:30:00.000Z'
      required:
      - id
      - email
      - isDefault
      - user
      - createdAt
      - updatedAt
    ReferenceObject:
      type: object
      description: A reference to a related resource
      properties:
        id:
          type: string
          description: Unique identifier of the referenced resource
          example: 550e8400-e29b-41d4-a716-446655440000
        _href:
          type: string
          description: API path to the referenced resource
          example: /v1/sequences/550e8400-e29b-41d4-a716-446655440000
      required:
      - id
      - _href
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 'Bearer token sent in the `Authorization` header. Accepts either a

        long-lived Nooks API key (`nooks-api-...`, from Developer Settings →

        API Keys) or an OAuth 2.0 access token issued by

        `https://oauth.nooks.in`. Use whichever you already have — the API

        validates both formats on the same header. For full OAuth flow

        details (authorize/token endpoints, scopes, refresh behavior) see

        the Authentication section of this spec''s introduction.

        '
x-tagGroups:
- name: API Reference
  tags:
  - Sequences
  - SequenceSteps
  - Emails
  - Users
  - SequenceStates
  - Prospects
  - Accounts
  - Notes
  - Mailboxes
  - Calls
  - CallDispositions
  - Tasks
  - EmailTemplates
  - Introspection