Slash Cardholder API

openapi: 3.2.0
info:
  title: Slash Public Cardholder API
  description: API description
  version: 0.0.1
  contact: {}
servers:
- url: https://api.slash.com
  description: production
security:
- api_key: []
- partner_api_key: []
- bearer: []
- developer_application: []
tags:
- name: Cardholder
paths:
  /cardholder:
    x-reference-path: paths/cardholder/route.yaml
    get:
      description: List cardholders for the caller's legal entity. Use the returned `id` as `cardholderId` when creating a card.
      parameters:
      - name: filter:legalEntityId
        in: query
        description: Pass in a legal entity ID to list cardholders for that legal entity. Required when authenticating with access to multiple legal entities.
        required: false
        schema:
          type: string
      - name: cursor
        required: false
        in: query
        schema:
          type: string
        description: A cursor string to fetch the next page of results
        x-reference-path: schemas/Pagination/CursorParameter.yaml
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Cardholder'
                      x-entrypoint:
                        virtualPath: schemas/Cardholder
                        sourcePath: schemas/Cardholder.yaml
                        title: Cardholder
                        origin: ./src/publicApi
                  metadata:
                    $ref: '#/components/schemas/Pagination.PaginationResponse'
                    x-entrypoint:
                      virtualPath: schemas/Pagination/PaginationResponse
                      sourcePath: schemas/Pagination/PaginationResponse.yaml
                      title: PaginationResponse
                      origin: ./src/publicApi
                required:
                - items
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: TooManyRequests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - api_key: []
      - bearer: []
      tags:
      - Cardholder
      summary: Get cardholder
      x-summary-source: derived
      operationId: getCardholder
      x-operation-id-source: derived
components:
  schemas:
    Error:
      type: object
      properties:
        message:
          type: string
        name:
          type: string
        identifier:
          type: string
        rawStatus:
          type: number
        meta:
          type: object
          additionalProperties: true
      required:
      - message
      - name
      - identifier
      - rawStatus
      x-entrypoint:
        origin: ./src/publicApi
        sourcePath: ./src/publicApi/main.yaml
        title: Error
        virtualPath: components/Error
      title: Error
    Cardholder:
      type: object
      description: A cardholder that can be assigned to cards created for the legal entity.
      properties:
        id:
          type: string
          description: Unique identifier for the cardholder. Use this as `cardholderId` when creating a card.
        userId:
          type: string
          description: Unique identifier for the user represented by this cardholder.
        legalEntityId:
          type: string
          description: Unique identifier for the legal entity this cardholder belongs to.
        email:
          type: string
          description: Email address for the cardholder.
        phoneNumber:
          type: string
          description: Phone number for the cardholder.
        firstName:
          type: string
          description: First name for the cardholder.
        lastName:
          type: string
          description: Last name for the cardholder.
        displayText:
          type: string
          description: Human-readable display text for the cardholder.
      required:
      - id
      - userId
      - legalEntityId
      - displayText
      x-entrypoint:
        virtualPath: schemas/Cardholder
        sourcePath: schemas/Cardholder.yaml
        title: Cardholder
        origin: ./src/publicApi
      title: Cardholder
    Pagination.PaginationResponse:
      type: object
      description: Response sent when requesting a list of data
      properties:
        nextCursor:
          type: string
          description: The cursor to use to retrieve the next page of data. If this is not sent, there is no more data to retrieve.
        count:
          type: number
          description: The number of items in the current page of data.
      x-entrypoint:
        virtualPath: schemas/Pagination/PaginationResponse
        sourcePath: schemas/Pagination/PaginationResponse.yaml
        title: PaginationResponse
        origin: ./src/publicApi
      title: PaginationResponse
  securitySchemes:
    api_key:
      type: apiKey
      description: "API key authentication for public API requests.\n\nKeys come in two flavors:\n\n- *Legal-entity-scoped keys* are pinned to a single legal entity.\n  Minted via the dashboard under a specific entity; every request\n  acts on that entity.\n- *User-scoped keys* are pinned to a user and span every legal\n  entity that user has access to. Every request made with a\n  user-scoped key (except `GET /legal-entity`, which lists the\n  legal entities the user can access) must include an\n  `x-legal-entity` header naming the legal entity the request is\n  operating on. Requests without the header are rejected with\n  `400`. The authenticated user must have an active permission\n  role on the supplied legal entity, otherwise the request is\n  rejected with `403`.\n"
      name: X-API-Key
      in: header
    partner_api_key:
      type: apiKey
      description: 'Partner-program API key authentication.


        Keys are minted in the partner dashboard (Developers → API Keys),

        are scoped to a single partner program, and are prefixed with

        `sk_partner_`. Partner keys are only accepted by routes that

        declare this scheme; they are rejected by `api_key` routes and

        vice versa.

        '
      name: X-API-Key
      in: header
    bearer:
      type: http
      scheme: bearer
    developer_application:
      type: http
      scheme: basic