CMS Tool API schema

Public API version 1.4.51.

Directory Listing

Manage directory listings

Endpoint URL

https://api.cms-tool.net/api/directoryListing

`/api/directoryListing`

Read and update directory listings.

GET

List listings, or retrieve one by appending its ID to the path. Needs the directoryListing:read scope.

Query parameters

Name	Type	Example	Notes
`id`	int	`123`	Filter results by id.
`page`	int	`123`	Filter results by page.
`classid`	int	`123`	Filter results to listings filed under this classification in any of the five classification columns.
`status`	int	`123`	Filter results by listing status: -1 archived, 0 new, 100 live, 101 to 109 priority levels, 200 top.
`minStatus`	int	`123`	Filter results to listings with this status or higher.
`maxStatus`	int	`123`	Filter results to listings with this status or lower.
`keywords`	text	`example`	Filter results by keywords.
`name`	text	`example`	Filter results by name.
`alphaid`	text	`bay-cafe`	Filter results to the listing with this SEO filename.
`email`	text	`customer@example.com`	Filter results by email.
`city`	text	`example`	Filter results by city.
`postcode`	text	`ABC123`	Filter results by postcode.
`country`	text	`NZ`	Filter results by country.
`mbr_id`	int	`123`	Filter results by mbr id.
`region_id`	int	`123`	Filter results by region id.
`createdAfter`	date	`2026-09-24`	Filter results by created after.
`createdBefore`	date	`2026-09-24`	Filter results by created before.
`updatedAfter`	date	`2026-09-24T14:30:00+12:00`	Filter results by updated after.
`updatedBefore`	date	`2026-09-24T14:30:00+12:00`	Filter results by updated before.
`orderBy`	text	`example`	Choose a supported sort field for this endpoint.
`orderDirection`	text	`example`	Use reverse to reverse the selected sort order.
`offset`	int	`123`	Skip this many matching records before returning results.
`pageSize`	int	`123`	Limit the number of records returned; accepted values are 1 through 999, with 200 used otherwise.

POST

Create or update a listing from a JSON object. Needs the directoryListing:write scope.

Request content type: application/json

Request body fields

Name	Type	Example	Notes
`id`	int	`123`	Set the id value.
`page`	int	`123`	Set the page value.
`name`	text	`example`	Set the name value.
`brief`	text	`example`	Short advert for the listing, shown in lists and search results.
`keywords`	text	`example`	Set the keywords value.
`alphaid`	text	`bay-cafe`	Unique SEO filename of the listing, used in its web address. Spaces become dashes.
`contact`	text	`example`	Set the contact value.
`email`	text	`customer@example.com`	Set the email value.
`url`	text	`https://www.example.com/`	Set the url value.
`phone`	text	`example`	Set the phone value.
`city`	text	`example`	Set the city value.
`country`	text	`NZ`	Set the country value.
`classid`	int	`123`	The classification the listing is filed under first.
`classid2`	int	`123`	A second classification the listing is filed under.
`status`	int	`123`	Listing status: -1 archived, 0 new, 100 live, 101 to 109 priority levels, 200 top.
`mbr_id`	int	`123`	Set the mbr id value.

Data definitions

Field	Type	Description	Example
`country`	text	Country of the physical address.
`num_max_occupancy`	int	Maximum occupancy, for accommodation and venue listings.
`madelive`	timestamp	Date and time the listing was made live.	2025-12-31 23:59:59
`keywords`	text	Keywords the listing can be found by.
`cost_daily_high`	decimal	Daily rate at peak times.
`widgetcode`	text	Widget or script code shown on the listing page, for example a booking widget.
`mbr_id`	int	ID of the member (login) that owns the listing. 0 when it is not linked to a member.
`phone2`	text	Second phone number.
`poststate`	text	State or province of the postal address.
`social6_url`	text	Address of another social network page, 6.
`logo_src`	text	Path of the listing's logo image.
`linkedin_username`	text	LinkedIn username.
`post`	text	Postal address.
`url2`	text	Another web link for the listing.
`contact`	text	Name of the manager or contact person.
`longadvert`	text	Long advert: the full description shown on the listing page.
`pricing_info`	text	Pricing information: rates, accommodation or venue costs.
`state`	text	State or province of the physical address.
`alphaid`	text	Unique SEO filename of the listing, used in its web address. Spaces become dashes. A leading slash makes it a published filename.
`num_bedrooms`	int	Number of bedrooms, for accommodation listings.
`social5_url`	text	Address of another social network page, 5.
`posttown`	text	Town or city of the postal address.
`social9_url`	text	Address of another social network page, 9.
`created`	timestamp	Date and time the listing was created.	2025-12-31 23:59:59
`region_id`	int	ID of the region the listing is in.
`postcode`	text	Zip or postal code of the physical address.
`postpostcode`	text	Zip or postal code of the postal address.
`social8_url`	text	Address of another social network page, 8.
`phone`	text	Phone number.
`name`	text	Organisation name of the listing.
`after_hours`	text	After hours contact number.
`failedreason`	text	Why the last email to the listing's address failed.
`social7_url`	text	Address of another social network page, 7.
`classid2`	int	ID of a second classification the listing is filed under. -1 means none.
`page`	int	Directory page that the listing belongs to.	123456
`updated`	timestamp	Date and time the listing was last changed.	2025-12-31 23:59:59
`place_latitude`	decimal	Map latitude of the listing, from -90 to 90.
`status`	int2	Listing status: -1 archived, 0 new, 100 live, 101 to 109 live with a higher priority, 200 top priority. A higher status sorts earlier in the directory, and archived listings are not counted in their classifications.
`hits_link`	int	Number of times the listing has been viewed.
`other`	text	Other contact details: any other methods of contact.
`classid4`	int	ID of a fourth classification the listing is filed under. -1 means none.
`lastconfirmemailsent`	timestamp	Date and time the last email was sent asking the business to confirm that its listing and email address are still correct. A listing that is not confirmed can go stale and, depending on the website's settings, is archived automatically.	2025-12-31 23:59:59
`city`	text	Town or city of the physical address.
`classid3`	int	ID of a third classification the listing is filed under. -1 means none.
`classid5`	int	ID of a fifth classification the listing is filed under. -1 means none.
`facebook_username`	text	Facebook username.
`twitter_username`	text	X (Twitter) username.
`social2_url`	text	Address of another social network page, 2.
`url_instant_redirect`	bool	True to send visitors straight to the listing's website instead of showing its listing page.
`floor_area_sqm`	int	Floor size in square metres.
`street`	text	Street address (physical address).
`mobile2`	text	Second mobile phone number.
`social1_url`	text	Address of another social network page, 1.
`dirhiddenreference`	text	The merchant's own reference for the listing, visible to the listing's owner.
`faileddate`	timestamp	Date the system last failed to deliver an email to the listing's address. Cleared when the status is changed.	2025-12-31 23:59:59
`cost_daily_low`	decimal	Daily rate off peak.
`email`	text	Contact email address of the listing.
`brief`	text	Short advert for the listing, shown in lists and search results.
`hours`	text	Opening hours, or club meeting hours.
`youtube_username`	text	YouTube username.
`place_longitude`	decimal	Map longitude of the listing, from -180 to 180.
`mobile`	text	Mobile phone number.
`json_features`	json	Features of the listing as a JSON object, with a key Feature followed by the ID of each feature that is set, for example Feature3.
`url`	text	Website address of the listing.
`social4_url`	text	Address of another social network page, 4.
`renewed`	timestamp	Date and time the listing was last renewed.	2025-12-31 23:59:59
`classid`	int	ID of the first classification the listing is filed under. -1 or 0 means none.
`deleted`	timestamp	Date and time the listing was archived by the system, if it was.	2025-12-31 23:59:59
`suburb`	text	Suburb of the physical address.
`social3_url`	text	Address of another social network page, 3.

Machine-readable documentation

This documentation is also available as JSON or Markdown at the same URL. Request JSON with Accept: application/json or Markdown with Accept: text/markdown.