# \ContactControllerApi

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

Method HTTP request Description
create_contact Post /contacts Create a contact
delete_contact Delete /contacts/{contactId} Delete contact
get_all_contacts Get /contacts/paginated Get all contacts
get_contact Get /contacts/{contactId} Get contact
get_contacts Get /contacts Get all contacts

# create_contact

crate::models::ContactDto create_contact(create_contact_options) Create a contact

# Parameters

Name Type Description Required Notes
create_contact_options CreateContactOptions createContactOptions [required]

# Return type

crate::models::ContactDto

# Authorization

API_KEY

# HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# delete_contact

delete_contact(contact_id) Delete contact

# Parameters

Name Type Description Required Notes
contact_id String contactId [required]

# Return type

(empty response body)

# Authorization

API_KEY

# HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# get_all_contacts

crate::models::PageContactProjection get_all_contacts(page, size, sort) Get all contacts

# Parameters

Name Type Description Required Notes
page Option<i32> Optional page index in inbox list pagination [default to 0]
size Option<i32> Optional page size in inbox list pagination [default to 20]
sort Option<String> Optional createdAt sort direction ASC or DESC [default to ASC]

# Return type

crate::models::PageContactProjection

# Authorization

API_KEY

# HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# get_contact

crate::models::ContactDto get_contact(contact_id) Get contact

# Parameters

Name Type Description Required Notes
contact_id String contactId [required]

# Return type

crate::models::ContactDto

# Authorization

API_KEY

# HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# get_contacts

Veccrate::models::ContactProjection get_contacts() Get all contacts

# Parameters

This endpoint does not need any parameter.

# Return type

Veccrate::models::ContactProjection

# Authorization

API_KEY

# HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]