GetMattered Public Reviews API

openapi: 3.2.0
info:
  contact:
    email: support@getmattered.com
    name: GetMattered
    url: https://getmattered.com
  description: 'The GetMattered API runs the whole job hunt for you: it matches you to roles that fit your profile, rewrites your resume for each posting, writes the cover letter the form asks for, and auto-applies across the major applicant tracking systems. Every send is tracked from the swipe to the employer''s own confirmation, so you always know what landed. Authenticate with a Bearer session token. The same surface powers the web app, the mobile app and the GetMattered MCP server for ChatGPT, Claude and other agents.'
  license:
    name: Proprietary
    url: https://getmattered.com/legal/terms
  title: GetMattered Public Reviews API
  version: e1c6af0f
servers:
- description: Current environment
  url: https://api.getmattered.com/api/v1
security:
- BearerAuth: []
tags:
- description: Published customer reviews.
  name: public-reviews
paths:
  /public/reviews:
    get:
      description: 'List published reviews for the marketing site: consented to publication by their author (consented reviews are approved automatically; an admin can reject one). Returns display name, rating, body (empty for a stars-only rating) and creation date - nothing that identifies the account - plus a `summary` with the count and mean rating over every published review.'
      summary: List public reviews
      tags:
      - public-reviews
      parameters:
      - schema:
          type: integer
          minimum: 1
          maximum: 50
          description: Maximum reviews to return. Defaults to 12.
          example: 12
        required: false
        description: Maximum reviews to return. Defaults to 12.
        name: limit
        in: query
      responses:
        '200':
          description: Approved and consented reviews, newest first, plus the aggregate rating.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicReviewsResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      operationId: getPublicReviews
components:
  schemas:
    PublicReviewsResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PublicReviewsPayload'
        meta:
          $ref: '#/components/schemas/ResponseMetadata'
        success:
          type: boolean
          enum:
          - true
      required:
      - data
      - success
      additionalProperties: false
      description: Successful API response
    ApiErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            context:
              oneOf:
              - type: object
                properties:
                  errorType:
                    type: string
                    enum:
                    - validation
                  field:
                    type: string
                  fieldErrors:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                        expected:
                          type: string
                        field:
                          type: string
                        message:
                          type: string
                        received:
                          type: string
                      required:
                      - field
                      - message
                  schemaName:
                    type: string
                required:
                - errorType
              - type: object
                properties:
                  attemptedEmail:
                    type: string
                    format: email
                  errorType:
                    type: string
                    enum:
                    - authentication
                  failureReason:
                    type: string
                    enum:
                    - invalid_credentials
                    - account_locked
                    - expired_token
                    - token_expired
                    - missing_token
                    - invalid_token
                    - session_expired
                    description: Reason for authentication failure
                    example: token_expired
                  ipAddress:
                    type: string
                  operation:
                    type: string
                  service:
                    type: string
                  userAgent:
                    type: string
                required:
                - errorType
              - type: object
                properties:
                  actualPermission:
                    type: string
                  errorType:
                    type: string
                    enum:
                    - authorization
                  requiredPermission:
                    type: string
                  resource:
                    type: string
                  resourceId:
                    type: string
                  userId:
                    type: string
                required:
                - errorType
              - type: object
                properties:
                  constraint:
                    type: string
                  errorType:
                    type: string
                    enum:
                    - database
                  operation:
                    type: string
                    enum:
                    - insert
                    - update
                    - delete
                    - select
                    - batch
                    - transaction
                    - migration
                    description: Type of database operation
                    example: select
                  resourceId:
                    type: string
                  sqlState:
                    type: string
                  table:
                    type: string
                  userId:
                    type: string
                required:
                - errorType
              - type: object
                properties:
                  endpoint:
                    type: string
                  errorType:
                    type: string
                    enum:
                    - external_service
                  httpStatus:
                    type: number
                  operation:
                    type: string
                  resourceId:
                    type: string
                  responseTime:
                    type: number
                  retryAttempt:
                    type: integer
                  service:
                    type: string
                  serviceName:
                    type: string
                  userId:
                    type: string
                required:
                - errorType
              - type: object
                properties:
                  errorType:
                    type: string
                    enum:
                    - resource
                  resource:
                    type: string
                  resourceId:
                    type: string
                  service:
                    type: string
                  userId:
                    type: string
                required:
                - errorType
              - type: object
                properties:
                  errorType:
                    type: string
                    enum:
                    - rate_limit
                  limit:
                    type: number
                  resetTime:
                    type: string
                  windowMs:
                    type: number
                required:
                - errorType
              - type: object
                properties:
                  configKey:
                    type: string
                  errorType:
                    type: string
                    enum:
                    - configuration
                  operation:
                    type: string
                  service:
                    type: string
                required:
                - errorType
              description: Type-safe error context information
              example:
                errorType: validation
                fieldErrors:
                - field: email
                  message: Invalid email format
            details:
              oneOf:
              - type: object
                properties:
                  detailType:
                    type: string
                    enum:
                    - validation
                  validationErrors:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                        field:
                          type: string
                        message:
                          type: string
                      required:
                      - field
                      - message
                required:
                - detailType
                - validationErrors
                additionalProperties: false
              - type: object
                properties:
                  detailType:
                    type: string
                    enum:
                    - service_error
                  originalError:
                    type: string
                  serviceName:
                    type: string
                required:
                - detailType
                - serviceName
                additionalProperties: false
              - type: object
                properties:
                  currentSize:
                    type: number
                  detailType:
                    type: string
                    enum:
                    - batch
                  originalError:
                    type: string
                  statementCount:
                    type: number
                required:
                - detailType
                additionalProperties: false
              - type: object
                properties:
                  detailType:
                    type: string
                    enum:
                    - rate_limit
                  limit:
                    type: number
                  resetTime:
                    type: string
                  windowMs:
                    type: number
                required:
                - detailType
                - limit
                - resetTime
                - windowMs
                additionalProperties: false
              - type: object
                properties:
                  conflictingField:
                    type: string
                  detailType:
                    type: string
                    enum:
                    - resource
                  resourceId:
                    anyOf:
                    - type: string
                    - type: number
                  resourceType:
                    type: string
                required:
                - detailType
                additionalProperties: false
              - type: object
                properties:
                  detailType:
                    type: string
                    enum:
                    - generic
                  info:
                    type: string
                required:
                - detailType
                additionalProperties: false
              - type: object
                properties:
                  currentTokens:
                    type: integer
                    minimum: 0
                  detailType:
                    type: string
                    enum:
                    - insufficient_tokens
                  requiredTokens:
                    type: integer
                    minimum: 0
                required:
                - currentTokens
                - detailType
                - requiredTokens
                additionalProperties: false
            message:
              type: string
            validation:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                - field
                - message
                additionalProperties: false
          required:
          - code
          - message
          additionalProperties: false
        meta:
          $ref: '#/components/schemas/ResponseMetadata'
        success:
          type: boolean
          enum:
          - false
      required:
      - error
      - success
      additionalProperties: false
    PublicReviewsPayload:
      type: object
      properties:
        reviews:
          type: array
          items:
            $ref: '#/components/schemas/PublicReview'
        summary:
          $ref: '#/components/schemas/PublicReviewsSummary'
      required:
      - reviews
      - summary
      additionalProperties: false
    PublicReview:
      type: object
      properties:
        body:
          type: string
          description: The review text, as written by the reviewer. Empty for a stars-only rating.
          example: I stopped writing cover letters by hand and started getting replies within a fortnight.
        createdAt:
          type: string
          description: When the review was written (ISO-8601). Feeds `datePublished` in the Review markup.
          example: '2026-08-31T09:15:00.000Z'
        displayName:
          type: string
          description: The credit the reviewer chose for themselves. Feeds `author.name` in the Review markup.
          example: Ava K.
        rating:
          type: integer
          minimum: 1
          maximum: 5
          description: Star rating, 1-5. Feeds `reviewRating.ratingValue`.
          example: 5
      required:
      - body
      - createdAt
      - displayName
      - rating
      additionalProperties: false
    ResponseMetadata:
      type: object
      properties:
        duration:
          type: number
          minimum: 0
          description: Request duration in milliseconds
          example: 150
        performance:
          type: object
          properties:
            dbQueries:
              type: integer
              minimum: 0
            totalDbTime:
              type: number
              minimum: 0
          description: Performance metrics (preview/local only)
        requestId:
          type: string
          description: Unique request identifier
          example: req_abc123
        timestamp:
          type: string
          format: date-time
          description: ISO 8601 timestamp
          example: '2026-11-03T14:00:48.054Z'
        version:
          type: string
          description: API version
          example: v1
    PublicReviewsSummary:
      type: object
      properties:
        ratingCount:
          type: integer
          minimum: 0
          description: Number of published reviews (approved AND consented), including stars-only ratings.
          example: 12
        ratingValue:
          type:
          - number
          - 'null'
          minimum: 1
          maximum: 5
          description: Mean star rating rounded to one decimal. Null when no review is published.
          example: 4.8
      required:
      - ratingCount
      - ratingValue
      additionalProperties: false
  securitySchemes:
    BearerAuth:
      description: 'Session token from signing in to GetMattered, sent as `Authorization: Bearer <token>`.'
      scheme: bearer
      type: http