Middesk subpackage_mail API
The subpackage_mail API from Middesk — 2 operation(s) for subpackage_mail.
The subpackage_mail API from Middesk — 2 operation(s) for subpackage_mail.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/middesk-subpackage-mail-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
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.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Middesk subpackage_actions Subpackage Mail API
version: 1.0.0
servers:
- url: https://api.middesk.com
description: Default
tags:
- name: subpackage_mail
paths:
/v1/partner/mail:
get:
operationId: list-mail-items
summary: List mail items
tags:
- subpackage_mail
parameters:
- name: page
in: query
description: Page number
required: false
schema:
type: integer
- name: per_page
in: query
description: Items per page
required: false
schema:
type: integer
- name: state
in: query
description: Filter by state
required: false
schema:
type: string
- name: q
in: query
description: Search query
required: false
schema:
type: string
- name: sort_by
in: query
description: Sort field
required: false
schema:
type: string
- name: sort_order
in: query
description: Sort order
required: false
schema:
type: string
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
responses:
'200':
description: mail items list
content:
application/json:
schema:
$ref: '#/components/schemas/type_mail_ListMailItemsResponse'
/v1/partner/mail/{id}:
get:
operationId: get-mail-item
summary: Retrieve a mail item
tags:
- subpackage_mail
parameters:
- name: id
in: path
description: Mail item ID
required: true
schema:
type: string
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
responses:
'200':
description: Successful response
'404':
description: mail item not found
content:
application/json:
schema:
$ref: '#/components/schemas/type__ErrorResponse'
patch:
operationId: update-mail-item
summary: Update a mail item
tags:
- subpackage_mail
parameters:
- name: id
in: path
description: Mail item ID
required: true
schema:
type: string
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
responses:
'200':
description: Successful response
'404':
description: mail item not found
content:
application/json:
schema:
$ref: '#/components/schemas/type__ErrorResponse'
requestBody:
content:
application/json:
schema:
type: array
items:
type: string
components:
schemas:
type__ErrorResponseErrorsItem:
type: object
properties:
message:
type: string
required:
- message
title: ErrorResponseErrorsItem
type__AgentMail:
type: object
properties:
object:
type: string
id:
type: string
format: uuid
arrived_at:
type:
- string
- 'null'
format: date-time
external_id:
type:
- string
- 'null'
sender_name:
type:
- string
- 'null'
recipient_name:
type:
- string
- 'null'
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
mail_viewed:
type: boolean
agency_name:
type:
- string
- 'null'
tag_names:
type: array
items:
type: string
description: List of tags associated with the mail item
internal_status:
type: string
description: Internal processing status
notes:
type:
- string
- 'null'
document_url:
type:
- string
- 'null'
format: uri
summary_payload:
type:
- object
- 'null'
additionalProperties:
description: Any type
suggested_mail_tag:
type:
- string
- 'null'
suggested_partner_name:
type:
- string
- 'null'
suggested_action_request:
type: boolean
mailbox_name:
type:
- string
- 'null'
registration_request_id:
type:
- string
- 'null'
format: uuid
state:
oneOf:
- $ref: '#/components/schemas/type__AgentMailState'
- type: 'null'
description: State from associated mailable
source:
$ref: '#/components/schemas/type__AgentMailSource'
company:
$ref: '#/components/schemas/type__AgentMailCompany'
document:
type:
- object
- 'null'
additionalProperties:
description: Any type
description: Associated document details
required:
- object
- id
- created_at
- updated_at
- mail_viewed
- tag_names
- suggested_action_request
- source
- company
title: AgentMail
type__AgentMailState:
type: string
enum:
- AL
- AK
- AZ
- AR
- CA
- CO
- CT
- DE
- FL
- GA
- HI
- ID
- IL
- IN
- IA
- KS
- KY
- LA
- ME
- MD
- MA
- MI
- MN
- MS
- MO
- MT
- NE
- NV
- NH
- NJ
- NM
- NY
- NC
- ND
- OH
- OK
- OR
- PA
- RI
- SC
- SD
- TN
- TX
- UT
- VT
- VA
- WA
- WV
- WI
- WY
description: State from associated mailable
title: AgentMailState
type__ErrorResponse:
type: object
properties:
errors:
type: array
items:
$ref: '#/components/schemas/type__ErrorResponseErrorsItem'
required:
- errors
title: ErrorResponse
type__AgentMailSource:
type: object
properties:
type:
type: string
description: Type of the source object
id:
type:
- string
- 'null'
format: uuid
description: ID of the source object
title: AgentMailSource
type_mail_ListMailItemsResponse:
type: object
properties:
object:
type: string
data:
type: array
items:
$ref: '#/components/schemas/type__AgentMail'
url:
type: string
has_more:
type: boolean
count:
type: integer
title: ListMailItemsResponse
type__AgentMailCompany:
type: object
properties:
id:
type: string
format: uuid
legal_name:
type:
- string
- 'null'
dba_name:
type:
- string
- 'null'
provider_company_id:
type:
- string
- 'null'
external_id:
type:
- string
- 'null'
parent_account_name:
type:
- string
- 'null'
title: AgentMailCompany
securitySchemes:
bearer_auth:
type: http
scheme: bearer