Home → API Documentation → Directory → api/Directory

3.1. api/Directory

This API call will return all records deemed as members, which can be displayed in a directory.

All records which have an applicable membership status set to denote the record as a member will return.

Additionally, only records where the Comp/Ind field is set to Company will return. The Comp/Ind field can be located in the General section of the Primary Record.

You can either pass an empty string for the cid, which will return all records, or you can provide a specific cid to return data for a specific company.

 

---

 

Parameters To Submit

Parameters can be submitted as blank values.

Parameter	Parameter Help	Parameter Data Type
uid	Logged in user’s uid.	String – Max 50 chars
cid	Company cid if you require only specific company information to return.	String – Max 50 chars
API Key

 

 

---

 

Return Response

The API call ResponseMessage will return the following fields of data.

Field	Field Help
cid	Primary record's GUID.
CompanyID	Primary record's ID number.
Company	Primary record's name.
CompanyTel	Generic primary record telephone number.
CompanyFax	Primary record's fax number.
CompanyEmail	Generic primary record email.
CompanyWeb	Primary record's website URL.
Category	The business category of the primary record.
BusinessDescription	The primary record's business description.
Address1	First line of the primary record's address.
Address2	Second line of the primary record's address.
Address3	Third line of the primary record's address.
Address4	Fourth line of the primary record's address.
County	County set on the primary record's address.
Postcode	Primary record's postcode.
Country	Country set on the primary record's address.
Offers	The number of member offers the primary record has set to display will be returned.
CompanyLogo	The URL of the primary record's logo.
Twitter	URL of the primary record's Twitter.
LinkedIn	URL of the primary record's LinkedIn.
Facebook	URL of the primary record's Facebook.
YouTube	URL of the primary record's YouTube.
Google	URL of the primary record's Google+.
Instagram	URL of the primary record's Instagram.
Yammer	URL of the primary record's Yammer.
Pinterest	URL of the primary record's Pinterest.