GetMattered

GetMattered Email Preferences API

The email-preferences API from GetMattered — 3 operation(s) for email-preferences.

GitHub OpenAPI

Operations 6

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /email-preferences Get my email subscription settings · Get Email Preferences #
Ask an LLM
“Which emails am I currently subscribed to?”
“Am I opted in to the weekly recap email?”
Tell an agent
Show my email preferences.
List which email types I receive.
PUT /email-preferences Change my email subscription settings · Update Email Preferences #
Ask an LLM
“How do I stop getting product update emails while signed in?”
“Can I turn off re-engagement emails but keep the weekly recap?”
Tell an agent
Turn my weekly recap emails {weeklyRecap}.
Set product updates to {productUpdates} and unsubscribe all to {unsubscribeAll}.
PUT /email-preferences/contact-email Update Contact Email #
GET /email-preferences/by-token View email settings from an email link · Get Email Preferences by Token #
Ask an LLM
“Can I see my email settings from a link in an email without logging in?”
“What preferences does a signed email-preferences link show?”
Tell an agent
Show the email preferences for link token {token}.
Open my email settings using token {token}.
PUT /email-preferences/by-token Change email settings from an email link · Update Email Preferences by Token #
Ask an LLM
“Can I change which emails I get from the email link without signing in?”
“How do I opt out of onboarding emails using the link in a message?”
Tell an agent
Using token {token}, set weekly recap to {weeklyRecap}.
Unsubscribe from everything via email link token {token}: {unsubscribeAll}.
POST /email-preferences/one-click One-click unsubscribe from emails · One-Click Unsubscribe #
Ask an LLM
“Does the unsubscribe button in my mail client stop all emails in one click?”
“What handles the List-Unsubscribe one-click request?”
Tell an agent
One-click unsubscribe with token {token}.
Process a one-click list-unsubscribe for {token}.

Documentation

📖
APIReference
https://api.getmattered.com/api/v1/scalar

Specifications

⚙
OpenAPI
https://artifacts.apis.io/getmattered/openapi/getmattered-email-preferences-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/getmattered/json-schema/getmattered-patch-user-preferences-schema.json
📊
JSONSchema
https://artifacts.apis.io/getmattered/json-schema/getmattered-upsert-application-profile-schema.json
📊
JSONSchema
https://artifacts.apis.io/getmattered/json-schema/getmattered-auto-setup-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/getmattered/json-schema/getmattered-update-preferences-request-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/getmattered:getmattered-email-preferences-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

getmattered-email-preferences-api-openapi.yml Raw ↑ 
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 Email Preferences API
  version: e1c6af0f
servers:
- description: Current environment
  url: https://api.getmattered.com/api/v1
security:
- BearerAuth: []
tags:
- description: Email subscription preferences, including one-click unsubscribe.
  name: email-preferences
paths:
  /email-preferences:
    get:
      tags:
      - email-preferences
      summary: Get Email Preferences
      description: Get the authenticated user's email subscription preferences.
      responses:
        '200':
          description: Email preferences retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailPreferencesResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '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'
      operationId: getEmailPreferences
    put:
      tags:
      - email-preferences
      summary: Update Email Preferences
      description: Update the authenticated user's email subscription preferences.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateEmailPreferences'
      responses:
        '200':
          description: Email preferences updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailPreferencesUpdatedResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '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'
      operationId: putEmailPreferences
  /email-preferences/contact-email:
    put:
      tags:
      - email-preferences
      summary: Update Contact Email
      description: Set or clear the optional personal email that receives update mail when the account email is an Apple private relay address. Never required.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateContactEmail'
      responses:
        '200':
          description: Contact email updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailPreferencesUpdatedResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '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'
      operationId: putEmailPreferencesContactEmail
  /email-preferences/by-token:
    get:
      tags:
      - email-preferences
      summary: Get Email Preferences by Token
      description: Get email preferences using a signed token (public, no auth required).
      parameters:
      - schema:
          type: string
          minLength: 1
          description: Signed email preferences token
          example: eyJ1c2VySWQ...
        required: true
        description: Signed email preferences token
        name: token
        in: query
      responses:
        '200':
          description: Email preferences retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailPreferencesResponse'
        '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'
      operationId: getEmailPreferencesByToken
    put:
      tags:
      - email-preferences
      summary: Update Email Preferences by Token
      description: Update email preferences using a signed token (public, no auth required).
      parameters:
      - schema:
          type: string
          minLength: 1
          description: Signed email preferences token
          example: eyJ1c2VySWQ...
        required: true
        description: Signed email preferences token
        name: token
        in: query
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateEmailPreferences'
      responses:
        '200':
          description: Email preferences updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailPreferencesUpdatedResponse'
        '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'
      operationId: putEmailPreferencesByToken
  /email-preferences/one-click:
    post:
      tags:
      - email-preferences
      summary: One-Click Unsubscribe
      description: RFC 8058 one-click unsubscribe endpoint. Receives List-Unsubscribe=One-Click in form body.
      parameters:
      - schema:
          type: string
          minLength: 1
          description: Signed email preferences token
          example: eyJ1c2VySWQ...
        required: true
        description: Signed email preferences token
        name: token
        in: query
      responses:
        '200':
          description: Successfully unsubscribed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OneClickUnsubscribeResponse'
        '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'
      operationId: postEmailPreferencesOneClick
components:
  schemas:
    OneClickUnsubscribeResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            message:
              type: string
              description: Confirmation message
              example: Successfully unsubscribed
          required:
          - message
          additionalProperties: false
        meta:
          $ref: '#/components/schemas/ResponseMetadata'
        success:
          type: boolean
          enum:
          - true
      required:
      - data
      - success
      additionalProperties: false
      description: Successful API response
    EmailPreferencesResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/EmailPreferencesData'
        meta:
          $ref: '#/components/schemas/ResponseMetadata'
        success:
          type: boolean
          enum:
          - true
      required:
      - data
      - success
      additionalProperties: false
      description: Successful API response
    EmailPreferencesUpdatedResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/EmailPreferencesData'
        meta:
          $ref: '#/components/schemas/ResponseMetadata'
        success:
          type: boolean
          enum:
          - true
      required:
      - data
      - success
      additionalProperties: false
      description: Successful API response
    UpdateContactEmail:
      type: object
      properties:
        contactEmail:
          type:
          - string
          - 'null'
          maxLength: 254
          format: email
          description: Personal email to receive updates at instead of the Apple private relay address. null clears it.
          example: jane@gmail.com
      required:
      - contactEmail
      additionalProperties: false
    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
    EmailPreferencesData:
      type: object
      properties:
        notifyLocationFulfilled:
          type: boolean
          description: Receive alerts when a requested location starts showing jobs
          example: true
        notifyRoleFulfilled:
          type: boolean
          description: Receive alerts when a suggested role is added to the platform
          example: true
        onboarding:
          type: boolean
          description: Receive onboarding and tips emails
          example: true
        productUpdates:
          type: boolean
          description: Receive product update emails
          example: true
        reEngagement:
          type: boolean
          description: Receive re-engagement emails
          example: true
        unsubscribeAll:
          type: boolean
          description: Unsubscribe from all marketing emails
          example: false
        weeklyRecap:
          type: boolean
          description: Receive the weekly recap of your matches and applications
          example: true
        contactEmail:
          type:
          - string
          - 'null'
          format: email
          description: Optional personal address the user added. Update mail goes here instead of an Apple private relay address.
          example: null
        email:
          type: string
          format: email
          description: User email address
          example: user@example.com
        isPrivateRelay:
          type: boolean
          description: True when the account email is an Apple "Hide My Email" relay address
          example: false
      required:
      - notifyLocationFulfilled
      - notifyRoleFulfilled
      - onboarding
      - productUpdates
      - reEngagement
      - unsubscribeAll
      - weeklyRecap
      - contactEmail
      - email
      - isPrivateRelay
      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
    UpdateEmailPreferences:
      type: object
      properties:
        notifyLocationFulfilled:
          type: boolean
          description: Receive alerts when a requested location starts showing jobs
          example: true
        notifyRoleFulfilled:
          type: boolean
          description: Receive alerts when a suggested role is added to the platform
          example: true
        onboarding:
          type: boolean
          description: Receive onboarding and tips emails
          example: true
        productUpdates:
          type: boolean
          description: Receive product update emails
          example: true
        reEngagement:
          type: boolean
          description: Receive re-engagement emails
          example: true
        unsubscribeAll:
          type: boolean
          description: Unsubscribe from all marketing emails
          example: false
        weeklyRecap:
          type: boolean
          description: Receive the weekly recap of your matches and applications
          example: true
      additionalProperties: false
  securitySchemes:
    BearerAuth:
      description: 'Session token from signing in to GetMattered, sent as `Authorization: Bearer <token>`.'
      scheme: bearer
      type: http