Mosey Mail API
The Mail API from Mosey — 2 operation(s) for mail.
OpenAPI Specification
openapi: 3.1.0
info:
title: Mosey Accounts Mail API
description: If you'd like to use the Mosey API, please contact sales@mosey.com.
version: 1.0.0
x-logo:
url: null
tags:
- name: Mail
paths:
/mail:
get:
summary: List Mail
description: 'Returns mail information received by the authorized legal entity
Follow each returned `url` in order to download the mail content in PDF format'
operationId: get_legal_entity_mail_handler_mail_get
security:
- OAuth2PasswordBearer: []
- OAuth2PasswordBearer: []
parameters:
- name: start_date
in: query
required: false
schema:
anyOf:
- type: string
format: date
- type: 'null'
title: Start Date
- name: end_date
in: query
required: false
schema:
anyOf:
- type: string
format: date
- type: 'null'
title: End Date
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PlatformMail'
title: Response Get Legal Entity Mail Handler Mail Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Mail
/v2/mail:
get:
summary: List Mail
description: 'Returns mail information received by the authorized legal entity
Follow each returned `url` in order to download the mail content in PDF format'
operationId: get_legal_entity_mail_handler_v2_mail_get
security:
- OAuth2PasswordBearer: []
parameters:
- name: start_date
in: query
required: false
schema:
anyOf:
- type: string
format: date
- type: 'null'
title: Start Date
- name: end_date
in: query
required: false
schema:
anyOf:
- type: string
format: date
- type: 'null'
title: End Date
- name: region
in: query
required: false
schema:
anyOf:
- $ref: '#/components/schemas/StateCode'
- type: 'null'
title: Region
- name: legal_entity_public_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Legal Entity Public Id
- name: user_or_platform_public_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: User Or Platform Public Id
- name: platform_public_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Platform Public Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PlatformMail_2'
title: Response Get Legal Entity Mail Handler V2 Mail Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Mail
components:
schemas:
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
PlatformMail_2:
properties:
id:
type: string
title: Id
region:
anyOf:
- $ref: '#/components/schemas/StateCode'
- type: 'null'
type:
$ref: '#/components/schemas/MailType'
received:
type: string
format: date
title: Received
sender:
anyOf:
- type: string
- type: 'null'
title: Sender
file_url:
type: string
title: File Url
type: object
required:
- id
- type
- received
- file_url
title: PlatformMail
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
type: object
required:
- loc
- msg
- type
title: ValidationError
PlatformMail:
properties:
id:
type: string
title: Id
location_id:
anyOf:
- type: string
- type: 'null'
title: Location Id
type:
$ref: '#/components/schemas/MailType'
received:
type: string
format: date
title: Received
sender:
anyOf:
- type: string
- type: 'null'
title: Sender
file_url:
type: string
title: File Url
type: object
required:
- id
- type
- received
- file_url
title: PlatformMail
MailType:
type: string
enum:
- registered-agent
- external-mail
title: MailType
StateCode:
type: string
enum:
- AL
- AK
- AZ
- AR
- CA
- CO
- CT
- DE
- DC
- 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
title: StateCode
securitySchemes:
OAuth2PasswordBearer:
type: oauth2
flows:
password:
scopes: {}
tokenUrl: /api/token