# ContactControllerApi

All URIs are relative to https://api.mailslurp.com

Method HTTP request Description
createContact POST /contacts Create a contact
deleteContact DELETE /contacts/{contactId} Delete contact
getAllContacts GET /contacts/paginated Get all contacts
getContact GET /contacts/{contactId} Get contact
getContacts GET /contacts Get all contacts

# createContact

ContactDto createContact(createContactOptions)

Create a contact

# Parameters

Name Type Description Notes
createContactOptions CreateContactOptions createContactOptions

# Return type

ContactDto

# Authorization

API_KEY

# HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

# deleteContact

deleteContact(contactId)

Delete contact

# Parameters

Name Type Description Notes
contactId UUID contactId [default to null]

# Return type

null (empty response body)

# Authorization

API_KEY

# HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

# getAllContacts

PageContactProjection getAllContacts(page, size, sort)

Get all contacts

# Parameters

Name Type Description Notes
page Integer Optional page index in inbox list pagination [optional] [default to 0]
size Integer Optional page size in inbox list pagination [optional] [default to 20]
sort String Optional createdAt sort direction ASC or DESC [optional] [default to ASC] [enum: ASC, DESC]

# Return type

PageContactProjection

# Authorization

API_KEY

# HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

# getContact

ContactDto getContact(contactId)

Get contact

# Parameters

Name Type Description Notes
contactId UUID contactId [default to null]

# Return type

ContactDto

# Authorization

API_KEY

# HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

# getContacts

List getContacts()

Get all contacts

# Parameters

This endpoint does not need any parameter.

# Return type

List

# Authorization

API_KEY

# HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json