ContactControllerApi

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

MethodHTTP requestDescription
createContactPOST /contactsCreate a contact
deleteContactDELETE /contacts/{contactId}Delete contact
getAllContactsGET /contacts/paginatedGet all contacts
getContactGET /contacts/{contactId}Get contact
getContactVCardGET /contacts/{contactId}/downloadGet contact vCard vcf file
getContactsGET /contactsGet all contacts

createContact

ContactDto createContact(createContactOptions)

Create a contact

Parameters

NameTypeDescriptionNotes
createContactOptionsCreateContactOptionscreateContactOptions

Return type

ContactDto

Authorization

API_KEY

HTTP request headers

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

deleteContact

deleteContact(contactId)

Delete contact

Parameters

NameTypeDescriptionNotes
contactIdUUIDcontactId[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(before, page, since, size, sort)

Get all contacts

Parameters

NameTypeDescriptionNotes
beforeDateFilter by created at before the given timestamp[optional] [default to null]
pageIntegerOptional page in list pagination[optional] [default to 0]
sinceDateFilter by created at after the given timestamp[optional] [default to null]
sizeIntegerOptional page size in list pagination[optional] [default to 20]
sortStringOptional 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

NameTypeDescriptionNotes
contactIdUUIDcontactId[default to null]

Return type

ContactDto

Authorization

API_KEY

HTTP request headers

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

getContactVCard

byte[] getContactVCard(contactId)

Get contact vCard vcf file

Parameters

NameTypeDescriptionNotes
contactIdUUIDcontactId[default to null]

Return type

**byte[]**

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/octet-stream

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