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

# List aliases

> Retrieve a paginated list of aliases created. It supports pagination, filtering by `alias_type`, `status`, `merchant_identifier`, `start_date` and `expiration_date`.



## OpenAPI

````yaml get /v1/aggregators/{raast-aggregator-id}/aliases
openapi: 3.1.0
info:
  title: Raast Wire
  version: 1.0.0
  description: ''
servers:
  - url: https://api.getsafepay.com/raastwire
security: []
tags:
  - name: Aggregators
  - name: Access Keys
  - name: Merchants
  - name: Raast Merchants
  - name: Payments
  - name: Refunds
  - name: QRs
  - name: Utilities
  - name: Aliases
  - name: Ledgers
  - name: Webhooks
paths:
  /v1/aggregators/{raast-aggregator-id}/aliases:
    parameters:
      - $ref: '#/components/parameters/AggregatorIdParam'
    get:
      tags:
        - Aliases
      summary: List aliases
      description: >-
        Retrieve a paginated list of aliases created. It supports pagination,
        filtering by `alias_type`, `status`, `merchant_identifier`, `start_date`
        and `expiration_date`.
      parameters:
        - name: limit
          in: query
          required: false
          example: 10
          schema:
            type: integer
        - name: offset
          in: query
          required: false
          example: 0
          schema:
            type: integer
        - name: alias_type
          in: query
          required: false
          example: TILL_CODE
          schema:
            type: string
            enum:
              - TILL_CODE
        - name: status
          in: query
          required: false
          description: Filter aliases by status.
          example: Active
          schema:
            type: string
            enum:
              - Active
              - Suspended
        - name: merchant_identifier
          in: query
          required: false
          example: mer_553dad9b-3984-4131-8842-84983e922351
          schema:
            type: string
        - name: start_date
          in: query
          required: false
          example: '2028-10-10T00:00:00.000Z'
          schema:
            type: string
            format: date
        - name: expiration_date
          in: query
          required: false
          example: '2033-11-10T00:00:00.000Z'
          schema:
            type: string
            format: date
      responses:
        '200':
          $ref: '#/components/responses/ListAliasResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
      security:
        - apiKey: []
components:
  parameters:
    AggregatorIdParam:
      name: raast-aggregator-id
      in: path
      required: true
      schema:
        type: string
        example: agg_2288490a-2176-4de5-b373-0ffb6f8e2e6e
      description: The unique identifier for the aggregator
  responses:
    ListAliasResponse:
      description: This response contains a paginated list of aliases
      headers:
        Content-Length:
          $ref: '#/components/headers/ContentLengthHeader'
        Date:
          $ref: '#/components/headers/DateHeader'
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/StandardResponse'
              - type: object
                properties:
                  data:
                    type: object
                    properties:
                      alias:
                        type: array
                        description: List of aliases returned in the result set
                        items:
                          $ref: '#/components/schemas/Alias'
                      count:
                        type: string
                        description: Total number of aliases matching the filters
                        example: '4'
          examples:
            AliasList:
              value:
                api_version: v1
                data:
                  alias:
                    - id: '5'
                      token: als_3b5bbe1d-350e-4a33-9b0d-63386f87a328
                      merchant_id: mer_553dad9b-3984-4131-8842-84983e922351
                      alias_type: TILL_CODE
                      alias_value: '541661038'
                      status: Active
                      start_date: '2026-01-06'
                      expiration_date: '2036-01-06'
                      opening_date: '2026-01-06'
                      closing_date: '2036-01-06'
                      created_at: '2026-01-06T09:27:14Z'
                      updated_at: '2026-01-06T09:27:14Z'
                      alias_record_id: '464449'
                  count: '4'
    Unauthorized:
      description: Unauthorized
      headers:
        Content-Length:
          $ref: '#/components/headers/ContentLengthHeader'
        Date:
          $ref: '#/components/headers/DateHeader'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiErrorEnvelope'
          examples:
            Unauthorized:
              value:
                api_version: v1
                error:
                  code: error.unauthorized_access
                  message: partner access key is required in request header
  headers:
    ContentLengthHeader:
      schema:
        type: string
        example: '256'
    DateHeader:
      schema:
        type: string
        example: Sat, 12 Aug 2023 08:55:04 GMT
  schemas:
    StandardResponse:
      type: object
      description: Standard response structure for successful operations
      properties:
        api_version:
          type: string
          example: v1
          description: The current version of the API spec
        data:
          type: object
          description: Contains the response data
    Alias:
      type: object
      description: Raast alias record
      properties:
        id:
          type: string
        token:
          type: string
        merchant_id:
          type: string
        alias_type:
          type: string
          description: Type of alias (e.g., TILL_CODE)
        alias_value:
          type: string
          description: The alias value (e.g., 541732040)
        status:
          type: string
          description: Current status of the alias (e.g., Active, Suspended)
        start_date:
          type: string
          format: date
          description: Start date for the alias validity
        expiration_date:
          type: string
          format: date
          description: Expiration date for the alias validity
        opening_date:
          type: string
          format: date
          description: Opening date of the alias
        closing_date:
          type: string
          format: date
          description: Closing date of the alias
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        alias_record_id:
          type: string
          description: Raast alias record identifier
    ApiErrorEnvelope:
      type: object
      description: Error wrapper that includes the API version and error metadata
      properties:
        api_version:
          type: string
          description: Indicates the API version associated with the response
          example: v1
        error:
          description: Structured error details describing why the request failed
          allOf:
            - $ref: '#/components/schemas/ErrorResponse'
          example:
            code: error.unauthorized_access
            message: partner access key is required in request header
    ErrorResponse:
      type: object
      description: Standard error response structure
      properties:
        code:
          type: string
          description: Error code identifying the type of error
        message:
          type: string
          description: Human-readable error message
  securitySchemes:
    apiKey:
      type: apiKey
      name: X-SFPY-AGGREGATOR-SECRET-KEY
      in: header

````