API Contacts

Available Here


List/Search

HTTP Method: GET

URL: https://www.aplos.com/hermes/api/v1/contacts

Parameters:

  • f_email: Any part of any email, case insensitive
  • f_lastupdated: Last updated (created or modified). Format: yyyy-MM-ddTHH:mm:ss.SSSZ
  • f_name: Any part of any name (first, last and/or company), case insensitive
  • f_type: Type: individual, company

Headers:

  • Authorization = Bearer: [ACCESS TOKEN]
    The access token obtained via the authentication resource.
  • aplos-account-id = [ACCOUNT ID]
    The Aplos account (organization) you are accessing (OPTIONAL)

Example JSON:


{
  "version": "v2_0_0",
  "status": 200,
  "meta": {
    "resource_count": 1,
    "available_filters": {
      "f_email": "Any part of any email, case insensitive",
      "f_lastupdated": "Last updated (created or modified). Format: yyyy-MM-ddTHH:mm:ss.SSSZ",
      "f_name": "Any part of any name (first, last and/or company), case insensitive",
      "f_type": "Type: individual, company"
    }
  },
  "links": {
    "next": "/api/v1/contacts?page_size=1&page_num=2",
    "self": "/api/v1/contacts?page_size=1&page_num=1"
  },
  "data": {
    "contacts": [
      {
        "id": 1,
        "firstname": "Example",
        "lastname": "Contact",
        "companyname": "Aplos",
        "type": "individual",
        "email": "example@aplos.com",
        "created": "2014-12-31T01:23:45.678-0700",
        "modified": "2014-12-31T12:34:56.789-0700"
      }
    ]
  }
}

Get

HTTP Method: GET

URL: https://www.aplos.com/hermes/api/v1/contacts/:contactId

Parameters:

  • [NONE]

Headers:

  • Authorization = Bearer: [ACCESS TOKEN]
    The access token obtained via the authentication resource.
  • aplos-account-id = [ACCOUNT ID]
    The Aplos account (organization) you are accessing (OPTIONAL)

Example JSON:


{
  "version": "v2_0_0",
  "status": 200,
  "meta": {
    "resource_count": 1
  },
  "links": {
    "self": "/api/v1/contacts/1"
  },
  "data": {
    "contacts": [
      {
        "id": 1,
        "firstname": "Example",
        "lastname": "Contact",
        "companyname": "Aplos",
        "type": "individual",
        "email": "example@aplos.com",
        "emails": [
          {
            "name": "Other",
            "address": "example2@aplos.com",
            "is_primary": false
          },
          {
            "name": "Work",
            "address": "example@aplos.com",
            "is_primary": true
          }
        ],
        "phones": [
          {
            "name": "Mobile",
            "telnum": "1.888.274.1316",
            "is_primary": true
          }
        ],
        "addresses": [
          {
            "name": "Work",
            "is_primary": true,
            "street1": "1155 W Shaw Ave",
            "street2": "Suite 102",
            "city": "Fresno",
            "state": "CA",
            "country": "USA",
            "postal_code": "93711"
          },
          {
            "name": "Work",
            "is_primary": false,
            "street1": "2225 E Bayshore Rd",
            "street2": "#100",
            "city": "Palo Alto",
            "state": "CA",
            "postal_code": "94303"
          }
        ],
        "created": "2014-12-31T01:23:45.678-0700",
        "modified": "2014-12-31T12:34:56.789-0700"
      }
    ]
  }
}

Post

NOT AVAILABLE

HTTP Method: POST

URL: https://www.aplos.com/hermes/api/v1/contacts

Parameters:

  • [NONE]

Headers:

  • Authorization = Bearer: [ACCESS TOKEN]
    The access token obtained via the authentication resource.
  • aplos-account-id = [ACCOUNT ID]
    The Aplos account (organization) you are accessing (OPTIONAL)

Example JSON Body:


{
   "todo": "implement this method"
}

Example JSON Response:


{
  "version": "v2_0_0",
  "status": 405,
  "exception": {
    "message": "Caller requested a resource that is not available.",
    "code": 3001
  }
}

Put

NOT AVAILABLE

HTTP Method: PUT

URL: https://www.aplos.com/hermes/api/v1/contacts/:contactId

Parameters:

  • [NONE]

Headers:

  • Authorization = Bearer: [ACCESS TOKEN]
    The access token obtained via the authentication resource.
  • aplos-account-id = [ACCOUNT ID]
    The Aplos account (organization) you are accessing (OPTIONAL)

Example JSON Body:


{
   "todo": "implement this method"
}

Example JSON Response:


{
  "version": "v2_0_0",
  "status": 405,
  "exception": {
    "message": "Caller requested a resource that is not available.",
    "code": 3001
  }
}

Delete

NOT AVAILABLE

HTTP Method: DELETE

URL: https://www.aplos.com/hermes/api/v1/contacts/:contactId

Parameters:

  • [NONE]

Headers:

  • Authorization = Bearer: [ACCESS TOKEN]
    The access token obtained via the authentication resource.
  • aplos-account-id = [ACCOUNT ID]
    The Aplos account (organization) you are accessing (OPTIONAL)

Example JSON Body:


{
   "todo": "implement this method"
}

Example JSON Response:


{
  "version": "v2_0_0",
  "status": 405,
  "exception": {
    "message": "Caller requested a resource that is not available.",
    "code": 3001
  }
}


Create Your Aplos Account

Try everything free for 15-days!

Must include min. 8 characters, upper and lower case letter, number & special character
What day of the week is it (e.g. Sunday)?

By creating your Aplos account, you are agreeing to our Terms and Conditions.