Resources

Full Ad

Fields

Field Type Description
absolute_url string Web frontend URL for ad, relative to doc root
business rel All fields on the Business object
created datetime Date/time ad was created
description string Description of ad
end_date string Date event ends (if not same as start_date)
has_coupons boolean True if ad contains coupons
headline string Ad title
id int Identifier
image string Absolute URL of ad image
is_primary boolean Make the ad/coupon show up in the right rail of the businesses pages
modified datetime Last modified date/time of ad.
resource_uri string URI of resource object
start_date string Date of event

User

Fields

Field Type Description
absolute_url string URL of user’s public profile
date_joined datetime Date/time user created account
first_name string First name of user
id int Identifier
is_active boolean Whether the user has verified their account and can log in
is_staff boolean Whether this is a staff account
last_login datetime Date/time user last logged in
last_name string Last name of user
resource_uri string URI of resource object
username string Username used to log in and to identify user on site

Business

Fields

Field Type Description
absolute_url string Web frontend URL for business, relative to doc root
additional_hours_info string Extra information about business hours
address1 string Contact address, line 1
address2 string Contact address, line 2
business_type rel Business Type object
categories rel Category object list
city string Contact city of business
created datetime Date/time business was added to database
description string Description of business
email string Contact email for business
extension1 string Phone extension for phone1
extension2 string Phone extension for phone2
fax string Fax number
id int Identifier
latitude string Latitude of business
longitude string Longitude of business
mailing_address1 string Mailing address, line 1
mailing_address2 string Mailing address, line 2
mailing_city string Mailing city
mailing_state string Mailing state
mailing_zip_code string Mailing zip/postal code
meta_description string Description used for META tags / SEO only
modified string Last modified date of business data
name string Name of business
nickname string Alternative name
phone1 string Phone number 1
phone2 string Phone number 2
photo string URL of lead business photo
point string Latitude/longitude of business in string
pre_name string Stop word such as “The” used to prefix the business name
resource_uri string URI of resource object
slug string Business slug (URL name)
state string State
suggested_type string  
validated boolean Status of validation of business
website string URL of business website
zip_code string Contact zip/postal code

Business Type

Note

This resource has no endpoint.

Fields

Field Type Description
id int identifier
codename string lowercase name (eg. “retail”)
name string full uppercase name (eg. “Retail”)

Category

Fields

Field Type Description
hierarchy rel Hierarchy object
id int Identifier
name string Upper-case name of category
parent rel Business that is a container for the this category
path string Full category path with leading slash (eg. “/Clothing/Retail”)
resource_uri string URI of resource object
slug string Slug
slug_path string Category path using slugs with a leading slash (eg. “/clothing/retail”)

Relations

Content Type

Fields

Field Type Description
app_label string Lower-case app name
id int Identifier
model string Lower-case model name
name string Lower-case human readable model name

Event

Fields

Field Type Description
absolute_url string Web frontend URL for business, relative to doc root
business rel Business object
created datetime Date/time event was added to database
date date Date of event
description string Description of business
end_time time End time of event
id int Identifier
modified datetime Date/time event was last modified
name string Name of event
resource_uri string URI of resource object
start_time time Start time of event

Hierarchy

Fields

Field Type Description
id int Identifier
name string Name of hierarchy
slug string Hierarchy slug (URL name)

Market

Note

This resource has no endpoint.

Fields

Field Type Description
absolute_url string Web frontend URL for market, relative to doc root
ad_call string Ad invocation code (raw HTML)
allow_reviews boolean True if market allows business reviews, false otherwise
apple_touch_icon string 60x60 PNG icon used for iPod Touch and iPhone devices
contact_info string Extra contact info for feedback form
contact_phone string Contact phone number
created datetime Date/time market was added to database
css_override string Extra CSS to be inserted into <style> tag
favicon string A market specific favicon about 16x16 pixels
footer_links string Extra string to be inserted into footer (such as copyright text)
header_logo_image string Image used as header
icon string Custom marker icon in PNG format
id int Identifier
mobile_header_logo_image string Mobile header logo image
modified datetime Last modified date of market data
name string Name of market
postal_codes rel Postal Code object list
public boolean True if the market is public
resource_uri string URI of resource object
search_point_icon string Custom marker used to denote user’s location
shortcut_link string Top-level URL for shortcut links
sites rel Site object list
slug string Slug for market
support_email string Email address for support
tracking_code string Javascript code for Google Analytics or other tracking service

Photo

Fields

Field Type Description
absolute_url string Web frontend URL for market, relative to doc root
business rel Business object
created datetime Date/time photo was added to database
description string Description of photo
id int Identifier
image string Absolute URL of image
modified datetime Last modified date of business data
resource_uri string URI of resource object
slot int Set to “1” if logo is header image, otherwise “null”
title string Title of photo

Post

Fields

Field Type Description
absolute_url string URL for post, relative to doc root
body string Text of the post
business rel Business object
comment_status int Status for allowing comments on this post
id int Identifier
ip_address string IP address of reviewer
resource_uri string URI of resource object
slug string Post slug (URL name)
timestamp datetime Date & time post was created
title string Title of the post
user rel User who created post

Postal Code

Note

This resource has no endpoint.

Fields

Field Type Description
created datetime Date/time postal code was added to database
modified datetime Last modified date of postal code
postal_code string 5-digit postal code

Product

Fields

Field Type Description
absolute_url string Web frontend URL for product, relative to doc root
business rel Business object
categories rel Category object list
created datetime Date/time product was added to database
description string Product description
id int Identifier
image string URL of product image
is_featured boolean True if product is featured on the business detail page
modified datetime Last modified date of product data
name string Name of product
price float Price of product
resource_uri string URI of resource object
url string URL where you can purchase the product

Relations

Rate

Fields

Field Type Description
active boolean Whether the Rate object is active and contributes to the total Rating
date datetime Date/time rate was added to the database
id int Identifier
value int Rating score
resource_uri string URI of resource object
user rel User object

Review

Fields

Field Type Description
absolute_url string URL for review, relative to doc root
comment string Text of review
content_type rel Content Type object
created datetime Date/time review was added to database
id int Identifier
ip_address string IP address of reviewer
object_pk string ID of reviewed object
rate rel Rate object
rating int Rating between 1-5
resource_uri string URI of resource object
site rel Site object
user_name string Full name of user
user_url string User’s URL
user rel User object

Relations

Site

Note

This resource has no endpoint.

Fields

Field Type Description
domain string Domain of site
id int Identifier
name string Name of site