openapi: 3.2.0
info:
  title: Rackspace Customer Service Customer Accounts API
  version: '1.0'
  description: The Rackspace Customer Service API exposes customer account, contact, and metadata operations. It lets internal users and integrations look up customer accounts the caller has access to (via tenant assignment), inspect account and customer history, and read service-level metadata associated with a customer resource.
  contact:
    name: Rackspace Technology
    url: https://www.rackspace.com/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  x-generated-from: documentation
  x-source-url: https://github.com/rackerlabs/docs-customer-service
  x-last-validated: '2026-05-05'
servers:
- url: https://accounts.api.rackspacecloud.com
  description: Rackspace Customer Service production endpoint.
security:
- AuthToken: []
tags:
- name: Customer Accounts
  description: Customer-account lookup and history operations.
paths:
  /v1/customer_accounts:
    get:
      operationId: getListOfCustomerAccounts
      summary: Get List Of Customer Accounts
      description: Returns the list of customer accounts the caller has access to based on their tenants.
      tags:
      - Customer Accounts
      responses:
        '200':
          description: Customer accounts returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerAccountList'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v1/customer_accounts/{rcn}:
    parameters:
    - $ref: '#/components/parameters/RCN'
    get:
      operationId: getCustomerAccount
      summary: Get Customer Account
      description: Returns details about a single customer account.
      tags:
      - Customer Accounts
      responses:
        '200':
          description: Customer account returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerAccount'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v1/customer_accounts/{rcn}/status_history:
    parameters:
    - $ref: '#/components/parameters/RCN'
    get:
      operationId: getListOfCustomerAccountStatusHistory
      summary: Get List Of Customer Account Status History
      description: Returns the status-change history for the customer account.
      tags:
      - Customer Accounts
      responses:
        '200':
          description: Status history returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountStatusHistory'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v1/customer_accounts/{rcn}/history:
    parameters:
    - $ref: '#/components/parameters/RCN'
    get:
      operationId: getListOfCustomerAccountHistory
      summary: Get List Of Customer Account History
      description: Returns the change history for the customer account.
      tags:
      - Customer Accounts
      responses:
        '200':
          description: Account history returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountHistory'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v1/customers/{customerId}/history:
    parameters:
    - $ref: '#/components/parameters/CustomerId'
    get:
      operationId: getListOfCustomerHistory
      summary: Get List Of Customer History
      description: Returns the change history for the customer.
      tags:
      - Customer Accounts
      responses:
        '200':
          description: Customer history returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerHistory'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    CustomerAccountList:
      title: CustomerAccountList
      type: object
      properties:
        customer_accounts:
          type: array
          items:
            $ref: '#/components/schemas/CustomerAccount'
        totalEntries:
          type: integer
    CustomerHistory:
      allOf:
      - $ref: '#/components/schemas/AccountHistory'
    Metadata:
      title: Metadata
      type: object
      properties:
        key:
          type: string
        value:
          type: string
        category:
          type: string
    AccountHistory:
      title: AccountHistory
      type: object
      properties:
        history:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              previousValue:
                type: string
              newValue:
                type: string
              changedAt:
                type: string
                format: date-time
              changedBy:
                type: string
    Fault:
      title: Fault
      type: object
      properties:
        code:
          type: integer
        message:
          type: string
        details:
          type: string
    CustomerAccount:
      title: CustomerAccount
      type: object
      properties:
        rcn:
          type: string
          description: Rackspace Customer Number.
        name:
          type: string
        status:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        customerSegment:
          type: string
        billingCountry:
          type: string
        contacts:
          type: array
          items:
            $ref: '#/components/schemas/Contact'
        metadata:
          type: array
          items:
            $ref: '#/components/schemas/Metadata'
    Contact:
      title: Contact
      type: object
      properties:
        id:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
          format: email
        phone:
          type: string
        roles:
          type: array
          items:
            type: string
        primary:
          type: boolean
    AccountStatusHistory:
      title: AccountStatusHistory
      type: object
      properties:
        history:
          type: array
          items:
            type: object
            properties:
              status:
                type: string
              changedAt:
                type: string
                format: date-time
              changedBy:
                type: string
              reason:
                type: string
  responses:
    BadRequest:
      description: Bad request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Fault'
    NotFound:
      description: Not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Fault'
    Unauthorized:
      description: Unauthorized.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Fault'
    Forbidden:
      description: Forbidden.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Fault'
  parameters:
    RCN:
      in: path
      name: rcn
      required: true
      description: The Rackspace Customer Number (RCN) identifying the customer account.
      schema:
        type: string
    CustomerId:
      in: path
      name: customerId
      required: true
      schema:
        type: string
  securitySchemes:
    AuthToken:
      type: apiKey
      in: header
      name: X-Auth-Token