Handling contacts

This page will help you getting contacts for your account through the Filemail API.

As per now, the only available operation on contacts through our Public API is searching the contact list. Any matches is returned in an array with stored Name and E-mail and also a parameter isGroup that if true means that this is a group of contacts.

post

Performs a search in current user's contacts and contact groups. Returns a list of matching contacts and groups.

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

termstring · min: 1Required

The search phrase. For contact groups - it matches any substring of the group name. For contacts - it matches any substring of contact name or email address.

excludestring[] · nullableOptional

List of email addresses and contact group names to exclude from search results.

limitinteger · int32 · nullableOptional

Optional limit of returned search results. Note that results are first sorted by contact/group name, then by email. Search results will be limited to the requested limit based on the mentioned sort order.

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

text/plainapplication/jsontext/json

post

/contact/search

HTTPcURLJavaScriptPython

POST /contact/search HTTP/1.1
Host: api-public.filemail.com
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 44

{
  "term": "text",
  "exclude": [
    "text"
  ],
  "limit": 1
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

{
  "responsestatus": "OK",
  "errorid": "text",
  "errormessage": "text",
  "data": {
    "contacts": [
      {
        "name": "text",
        "email": "text",
        "isGroup": true,
        "memberCount": 1
      }
    ]
  },
  "errorcode": 1
}