Get all contacts created

What it does

Returns all contacts created by your API key. You can get the contact id from the list to edit or delete it, also you can specify friendlyName to filter the results.

Endpoint

GET

/byon/contacts/v1/

Request Querystring Parameters

Attributes

Description

friendlyName
optional

A filter on the list based on the friendlyName (string) field.

Curl example

curl -X GET "https://api.tyntec.com/byon/contacts/v1/" -H  "accept: application/json" -H  "apiKey: ds9SomeApiKeyl337"

Curl example with optional Attributes

curl -X GET "https://api.tyntec.com/byon/contacts/v1/?friendlyName=myFriendlyName" -H  "accept: application/json" -H  "apiKey: ds9SomeApiKeyl337"

 

Responses

Code

Description

200

The list of contacts
[
  {
    "contacts": [
      {      
	"accountId": "string",
    	"contactId": "string",
	"friendlyName": "string",
    	"companyName": "string",
	"companyAddress": "string",
	"contactName": "string",
	"contactEmail": "string",
     	"contactPhone": "string",
	"contactTitle": "string",
    	"dateCreated": 0,
      	"dateUpdated": 0,
      	"timestampCreated": "string",
      	"timestampUpdated": "string"
      }
    ],
    "size": 0
  }
]

Example

Response body

{
  "contacts": [
    {
      "accountId": "CPaasAccountName",
      "contactId": "26c99e4d97b44c9aa50bf7fb29801ebe",
      "friendlyName": "myFrienldyName",
      "companyName": "myCompanyName",
      "companyAddress": "myCompanyAddress",
      "contactName": "myContactName",
      "contactEmail": "mail@myemail.com",
      "contactPhone": "+49231123456789",
      "contactTitle": "myContactTitle",
      "dateCreated": 1521036849011,
      "dateUpdated": 1521036849011,
      "timestampCreated": "2018-03-14T14:14:09.011Z",
      "timestampUpdated": "2018-03-14T14:14:09.011Z"
    },
    {
      "accountId": "CPaasAccountName",
      "contactId": "2a6e092375d6447482e6fbec1600e470",
      "friendlyName": "myFrienldyName",
      "companyName": "myCompanyName",
      "companyAddress": "myCompanyAddress",
      "contactName": "myContactName",
      "contactEmail": "mail@myemail.com",
      "contactPhone": "+49231123456789",
      "contactTitle": "myContactTitle",
      "dateCreated": 1521113271275,
      "dateUpdated": 1521113271275,
      "timestampCreated": "2018-03-15T11:27:51.275Z",
      "timestampUpdated": "2018-03-15T11:27:51.275Z"
    }
  ],
  "size": 2
}

204

Empty list. No contacts found for this friendly name

401

Unauthorized

403

Forbidden

404

Not Found

500

Something went wrong :-(Example Value{  "code": "string",  "message": "string",  "timestamp": 0}