Get All Contact Fields

Users can fetch contact fields to get profile information of the contacts. Using this API, you can get the list of all contact fields.

Request Type:

Scope required

ZohoCampaigns.contact.READ

Other alternative scopes

ZohoCampaigns.contact.ALL (CREATE + UPDATE + DELETE + READ)

Header:

Authorization: Zoho-oauthtoken <access_token>

Content-Type: application/x-www-form-urlencoded

Request URL

https://campaigns.zoho.com/api/v1.1/contact/allfields

API Limit

Duration: 5 mins
Number of Calls: 100
Lock Period: 30 mins

You can send 100 API calls per 5 minutes. If you hit this limit, you can't use this API for the next 30 minutes due to security reasons, but you can still use other APIs if their lock period hasn’t been reached.

List of Parameters -- Version 1.1

Parameter	Data Type	Description
type*	String	xml (or) json

* - Mandatory Parameters

Possible Error Case

Error code	Description
903	Mandatory fields are missing.

If your error code is not listed above, click here.

Sample XML Request

Copiedhttps://campaigns.zoho.com/api/v1.1/contact/allfields?type=xml

Sample Response

Copied<response>
	<fieldname no="1">
		<DISPLAY_NAME>Contact Email</DISPLAY_NAME>
		<FIELD_NAME>contact_email</FIELD_NAME>
		<FIELD_ID>4000000000015</FIELD_ID>
	</fieldname>
	<fieldname no="2">
		<DISPLAY_NAME>Title</DISPLAY_NAME>
		<FIELD_NAME>title</FIELD_NAME>
		<FIELD_ID>4000000000017</FIELD_ID>
	</fieldname>
	<fieldname no="3">
		<DISPLAY_NAME>First Name</DISPLAY_NAME>
		<FIELD_NAME>firstname</FIELD_NAME>
		<FIELD_ID>4000000000019</FIELD_ID>
	</fieldname>
	<fieldname no="4">
		<DISPLAY_NAME>Last Name</DISPLAY_NAME>
		<FIELD_NAME>lastname</FIELD_NAME>
		<FIELD_ID>4000000000021</FIELD_ID>
	</fieldname>
	<fieldname no="5">
		<DISPLAY_NAME>Job Title</DISPLAY_NAME>
		<FIELD_NAME>job_title</FIELD_NAME>
		<FIELD_ID>4000000000023</FIELD_ID>
	</fieldname>
	<fieldname no="6">
		<DISPLAY_NAME>Company Name</DISPLAY_NAME>
		<FIELD_NAME>companyname</FIELD_NAME>
		<FIELD_ID>4000000000025</FIELD_ID>
	</fieldname>
	<fieldname no="7">
		<DISPLAY_NAME>Phone</DISPLAY_NAME>
		<FIELD_NAME>phone</FIELD_NAME>
		<FIELD_ID>4000000000027</FIELD_ID>
	</fieldname>
	<fieldname no="8">
		<DISPLAY_NAME>Secondary Email</DISPLAY_NAME>
		<FIELD_NAME>secondary_email</FIELD_NAME>
		<FIELD_ID>4000000000029</FIELD_ID>
	</fieldname>
	<message>success</message>
	<code>0</code>
</response>

Show full

Show less

Sample JSON Request

Copiedhttps://campaigns.zoho.com/api/v1.1contact/allfields?type=json

Sample Response

Copied{
  "response": {
    "message": "success",
    "code": "0",
    "fieldname": [
      {
        "DISPLAY_NAME": "Contact Email",
        "FIELD_NAME": "contact_email",
        "no": "1",
        "FIELD_ID": "4000000000015"
      },
      {
        "DISPLAY_NAME": "Title",
        "FIELD_NAME": "title",
        "no": "2",
        "FIELD_ID": "4000000000017"
      },
      {
        "DISPLAY_NAME": "First Name",
        "FIELD_NAME": "firstname",
        "no": "3",
        "FIELD_ID": "4000000000019"
      },
      {
        "DISPLAY_NAME": "Last Name",
        "FIELD_NAME": "lastname",
        "no": "4",
        "FIELD_ID": "4000000000021"
      },
      {
        "DISPLAY_NAME": "Job Title",
        "FIELD_NAME": "job_title",
        "no": "5",
        "FIELD_ID": "4000000000023"
      },
      {
        "DISPLAY_NAME": "Company Name",
        "FIELD_NAME": "companyname",
        "no": "6",
        "FIELD_ID": "4000000000025"
      },
      {
        "DISPLAY_NAME": "Phone",
        "FIELD_NAME": "phone",
        "no": "7",
        "FIELD_ID": "4000000000027"
      },
      {
        "DISPLAY_NAME": "Secondary Email",
        "FIELD_NAME": "secondary_email",
        "no": "8",
        "FIELD_ID": "4000000000029"
      },
      {
        "DISPLAY_NAME": "Mobile",
        "FIELD_NAME": "mobile",
        "no": "9",
        "FIELD_ID": "4000000000031"
      },
      {
        "DISPLAY_NAME": "Address",
        "FIELD_NAME": "address",
        "no": "10",
        "FIELD_ID": "4000000000033"
      },
      {
        "DISPLAY_NAME": "City",
        "FIELD_NAME": "city",
        "no": "11",
        "FIELD_ID": "4000000000035"
      },
      {
        "DISPLAY_NAME": "State",
        "FIELD_NAME": "state",
        "no": "12",
        "FIELD_ID": "4000000000037"
      },
      {
        "DISPLAY_NAME": "Zip Code",
        "FIELD_NAME": "zipcode",
        "no": "13",
        "FIELD_ID": "4000000000039"
      },
      {
        "DISPLAY_NAME": "Country",
        "FIELD_NAME": "country",
        "no": "14",
        "FIELD_ID": "4000000000041"
      },
      {
        "DISPLAY_NAME": "Website",
        "FIELD_NAME": "website",
        "no": "15",
        "FIELD_ID": "4000000000043"
      },
      {
        "DISPLAY_NAME": "Note",
        "FIELD_NAME": "note",
        "no": "16",
        "FIELD_ID": "4000000000051"
      },
      {
        "DISPLAY_NAME": "Twitter Handle",
        "FIELD_NAME": "twitter_handle",
        "no": "17",
        "FIELD_ID": "4000000000059"
      },
      {
        "DISPLAY_NAME": "Facebook Handle",
        "FIELD_NAME": "facebook_handle",
        "no": "18",
        "FIELD_ID": "4000000000061"
      },
      {
        "DISPLAY_NAME": "LinkedIn Handle",
        "FIELD_NAME": "linkedin_handle",
        "no": "19",
        "FIELD_ID": "4000000000063"
      }
    ]
  }
}

Show full

Show less

CRM

Voice

Sign

Forms

Bigin

SalesIQ

Bookings

RouteIQ

Thrive

CRM Plus

Zakya

Campaigns

Voice

Sign

Forms

Social

Survey

SalesIQ

Sites

Backstage

PageSense

Marketing Automation

LandingPage

Webinar

LeadChain

Domains

CommunitySpaces

Thrive

Publish

Marketing Plus

Commerce

Zakya

Desk

Assist

Voice

SalesIQ

Bookings

FSM

Lens

Solo

Service Plus

Books

Expense

Sign

Inventory

Invoice

Billing

Payroll

Commerce

Checkout

Practice

Solo

Payments

Finance Plus

Mail

Voice

Sign

WorkDrive

Bookings

Cliq

Notebook

Meeting

Connect

Learn

Office Integrator

Writer

TeamInbox

ZeptoMail

Show

Tables

Sheet

Office Suite

Calendar

ToDo

PDF Editor

Workplace

Vani

Expense

Recruit

People