Create an account now!
HOME FEATURES PRICING CONTACT US ABOUT CUSTOMER LOGIN

API Setup

To keep your CustomerBeach data safe and ensure you can only access your own account, we've developed a simple authentication system. Besides running over an SSL tunnel, each CustomerBeach account has its own unique API key that must be included in all interactions. In most some cases this will be combined with a GroupID, depending on the method being used.

Service Endpoint

The endpoint for each API method call is https://app.customerbeach.com/api/api.asmx. In addition to the documentation on this website, you can visit the URL in your browser to see the list of methods avaialble. To reach the WSDL description, use https://app.customerbeach.com/api/api.asmx?wsdl.

Your API key

You can find your unique API key under the Account tab, then Settings sub tab. The API Key is at the bottom of the Settings page:

GroupID

When operating on/or with contact groups, you'll need to get the contact group's GroupID. To find a particular group's GroupID, follow the steps below:

Contact Extra Fields

Several API functions use the ContactExtraField type (basically a Key/Value pair) as a means to submit contact data. The value is simply the value you are submitting, the key corresponds to the field. See the table below for the Key names you should use:

Field Name Key Name
Title title
First Name firstname
Middle Name middle
Last Name lastname
Company Name companyname
Job Title jobtitle
Website website
Phone phone1
Alt Phone phone2
Fax fax
Address Line 1 address1
Address Line 2 address2
City city
State state
Zip code zip
Birthdate birthdate   must be in the form MM/DD/YYYY
Extra Date extradate   must be in the form MM/DD/YYYY
Notes notes
Custom Field 1 custom1
Custom Field 2 custom2
Custom Field 3 custom3
Custom Field 4 custom4
Custom Field 5 custom5