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

 

Return Response

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

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