Fairmarkit Categories API

openapi: 3.1.1
info:
  title: BUYER PUBLIC Business Units Categories API
  version: '3'
  description: The Fairmarkit Buyer API is a RESTful API that uses HTTP requests to allow you to access and use your Fairmarkit data. It has predictable resource-oriented URLs that use standard HTTP response codes, authentication, and verbs. See the Fairmarkit API developer portal for more information.
  termsOfService: https://www.fairmarkit.com/terms-of-service
  contact:
    name: Fairmarkit Support
    url: https://fmkt.zendesk.com/hc/en-us
    email: support@fairmarkit.com
servers:
- url: https://staging.fairmarkit.com/
tags:
- name: Categories
paths:
  /services/self-service/api/v3/categories/:
    get:
      tags:
      - Categories
      summary: List Categories
      operationId: list_services_self_service_api_v3_categories__get
      parameters:
      - required: false
        schema:
          title: Limit
          maximum: 100
          minimum: 1
          type: integer
          default: 20
          description: Maximum number of records to return. Defaults to 20.
        name: limit
        in: query
        description: Maximum number of records to return. Defaults to 20.
      - required: false
        schema:
          title: Offset
          minimum: 0
          type: integer
          default: 0
          description: Zero-based offset of the first record to return. Defaults to 0.
        name: offset
        in: query
        description: Zero-based offset of the first record to return. Defaults to 0.
      - required: false
        schema:
          title: Offset
          type: string
        name: external_id
        in: query
        description: Filter Category records by external Category ID.
      - required: false
        schema:
          title: X-Fm-Api-Key
          type: string
        name: X-FM-API-KEY
        in: header
        description: Fairmarkit API Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ListRetrieve_CategoryRetrieve_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      description: Returns a list of categories.
components:
  schemas:
    ListRetrieve_CategoryRetrieve_:
      title: ListRetrieve[CategoryRetrieve]
      description: Paginated list response for categories.
      required:
      - count
      - results
      type: object
      properties:
        count:
          title: Count
          type: integer
          description: A count of the number of records in the full results set.
        next:
          title: Next
          type: string
          description: A URL to fetch the next page of results, if more results exist in the set.
        previous:
          title: Previous
          type: string
          description: A URL to fetch the previous page of results, if previous results exist in the set.
        results:
          title: Results
          type: array
          description: A list representing one page of the result set.
          items:
            $ref: '#/components/schemas/CategoryRetrieve'
    CategoryRetrieve:
      title: CategoryRetrieve
      description: Data to retrieve about a specific category.
      required:
      - uuid
      - title
      - visual_title
      - external_id
      type: object
      properties:
        uuid:
          title: Uuid
          type: string
          description: Category UUID.
        title:
          title: Title
          type: string
          description: Category name.
        visual_title:
          title: Visual Title
          type: string
          description: Category display name.
        external_id:
          title: External Id
          type: string
          description: Category external ID.
    HTTPValidationError:
      title: HTTPValidationError
      type: object
      description: Validation error response.
      properties:
        detail:
          title: Detail
          type: array
          description: Details about a specific error to display in error response.
          items:
            $ref: '#/components/schemas/ValidationError'
    ValidationError:
      title: ValidationError
      required:
      - loc
      - msg
      - type
      type: object
      description: Details for a validation error.
      properties:
        loc:
          title: Location
          type: array
          description: Error location
          items:
            anyOf:
            - type: string
            - type: integer
        msg:
          title: Message
          type: string
          description: Human readable explanation of the error.
        type:
          title: Error Type
          type: string
          description: Computer-readable identifier of the error type.