API

/{make}/attributes

GET /{make}/attributes.{_format}

List all attributes.

Documentation
Sandbox

Documentation

List all attributes.

Requirements

Name	Requirement	Type	Description
_format	xml\|json\|csv\|pdf\|html
make	[A-z]*

Filters

Name

Information

offset

Requirement	\d+
Description	Offset from which to start listing attributes.

limit

Requirement	\d+
Description	How many attributes to return.
Default	500

type

Requirement
Description	Type of attributes to return.

Return

Parameter	Type	Versions	Description
[]	array of objects (Attribute)	*
[][name]	string	*	Name.
[][type]	string	*	Type.
[][group]	string	*	Group Name.
[][id]	integer	*
[][position]	integer	*	Position

Status Codes

Status Code	Description
200	Returned when successful

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/{make}/attributes/types

GET /{make}/attributes/types.{_format}

List all attribute types.

Documentation
Sandbox

Documentation

List all attribute types.

Requirements

Name	Requirement	Type	Description
_format	xml\|json\|csv\|pdf\|html
make	[A-z]*

Status Codes

Status Code	Description
200	Returned when successful

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/{make}/cars/list

GET /{make}/cars/list.{_format}

List all cars.

Documentation
Sandbox

Documentation

List all cars.

Requirements

Name	Requirement	Type	Description
_format	xml\|json\|csv\|pdf\|html
make	[A-z]*

Filters

Name

Information

offset

Requirement	\d+
Description	Offset from which to start listing cars.

limit

Requirement	\d+
Description	How many cars to return.
Default	2000

filters

Requirement
Description	Filters

attributes

Requirement
Description	Attributes

order_by

Requirement
Description	Order By

deleted

Requirement
Description	Deleted

full

Requirement
Description	Full

Return

Parameter	Type	Versions	Description
[]	array of objects (Car)	*
[][attributes]	array	*	Get attributes
[][location]	integer	*	Get location id
[][finance]	integer	*	Get finance id
[][car_description]	integer	*	Get car_description id
[][active]	boolean	*	Active.
[][status]	string	*	Status.
[][id]	integer	*

Status Codes

Status Code	Description
200	Returned when successful

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/{make}/cars/simple

GET /{make}/cars/simple.{_format}

List all cars.

Documentation
Sandbox

Documentation

List all cars.

Requirements

Name	Requirement	Type	Description
_format	xml\|json\|csv\|pdf\|html
make	[A-z]*

Filters

Name

Information

offset

Requirement	\d+
Description	Offset from which to start listing cars.

limit

Requirement	\d+
Description	How many cars to return.
Default	2000

filters

Requirement
Description	Filters

attributes

Requirement
Description	Attributes

order_by

Requirement
Description	Order By

full

Requirement
Description	Full

search_result

Requirement
Description	Save search result

list

Requirement
Description	Attributes to get

Return

Parameter	Type	Versions	Description
[]	array of objects (Car)	*
[][attributes][]	array of objects (AttributeValue)	*
[][attributes][][attribute]	integer	*	{@inheritdoc}
[][attributes][][car]	integer	*	{@inheritdoc}
[][attributes][][name]	string	*	{@inheritdoc}
[][attributes][][position]	integer	*	{@inheritdoc}
[][attributes][][type]	string	*	{@inheritdoc}
[][attributes][][value]	string	*	Value.
[][attributes][][id]	integer	*
[][images]	array	*	Get only images
[][other_files]	array	*	Get all files except images
[][location]	integer	*	Get location id
[][finance]	integer	*	Get finance id
[][car_description]	integer	*	Get car_description id
[][active]	boolean	*	Active.
[][status]	string	*	Status.
[][created_at]	DateTime	*	Creation time.
[][updated_at]	DateTime	*	Update time.
[][stock]	boolean	*	Stock.
[][id]	integer	*
[][finance_products][]	array of objects (FinanceProduct)	*
[][finance_products][][id]	integer	*
[][finance_products][][name]	string	*	Name.
[][finance_products][][description]	string	*	Description.
[][service_packages][]	array of objects (ServicePackage)	*
[][service_packages][][icon]	integer	*	{@inheritdoc}
[][service_packages][][name]	string	*	Name.
[][service_packages][][description]	string	*	Description.
[][service_packages][][make]	string	*	Make.
[][service_packages][][package_type]	string	*	Package type.
[][service_packages][][url]	string	*	URL.
[][service_packages][][icon_thumb]	object (File)	*
[][service_packages][][icon_thumb][user]	integer	*	{@inheritdoc}
[][service_packages][][icon_thumb][type]	string	*	Type.
[][service_packages][][icon_thumb][created_at]	DateTime	*	Creation time.
[][service_packages][][icon_thumb][updated_at]	DateTime	*	Update time.
[][service_packages][][icon_thumb][id]	integer	*
[][service_packages][][icon_thumb][path]	string	*
[][service_packages][][icon_thumb][description]	string	*
[][service_packages][][icon_thumb][name]	string	*
[][service_packages][][icon_thumb][mime_type]	string	*
[][service_packages][][icon_thumb][size]	float	*
[][service_packages][][id]	integer	*
[][service_packages][][show_in_pdf]	boolean	*
[][service_packages][][show_in_corner]	string	*

Status Codes

Status Code	Description
200	Returned when successful

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/{make}/cars/statuses

GET /{make}/cars/statuses.{_format}

List all car statuses.

Documentation
Sandbox

Documentation

List all car statuses.

Requirements

Name	Requirement	Type	Description
_format	xml\|json\|csv\|pdf\|html
make	[A-z]*

Status Codes

Status Code	Description
200	Returned when successful

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/{make}/job_offers

GET /{make}/job_offers.{_format}

List all job offers.

Documentation
Sandbox

Documentation

List all job offers.

Requirements

Name	Requirement	Type	Description
_format	xml\|json\|csv\|pdf\|html
make	[A-z]*

Filters

Name

Information

offset

Requirement	\d+
Description	Offset from which to start listing jobOffers.

limit

Requirement	\d+
Description	How many jobOffers to return.
Default	500

filters

Requirement
Description	Filters

order_by

Requirement
Description	Order By

Return

Parameter	Type	Versions
[]	array of objects (JobOffers)	*
[][rmake_id]	string	*
[][url]	string	*
[][url_with_layout]	string	*
[][title]	string	*
[][publish_date]	DateTime	*
[][expiry_date]	DateTime	*
[][company]	string	*
[][location]	string	*
[][country]	string	*
[][country_region_id]	integer	*
[][country_region_name]	string	*
[][application_link]	string	*
[][company_description]	string	*
[][requirements]	string	*
[][opportunities]	string	*
[][notes]	string	*
[][clause]	string	*
[][experience]	string	*
[][job_offer_id]	integer	*
[][position_description]	string	*
[][last_modification_date]	DateTime	*
[][unique_id]	integer	*

Status Codes

Status Code	Description
200	Returned when successful

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/{make}/job_offers/import

GET /{make}/job_offers/import.{_format}

List all job offers.

Documentation
Sandbox

Documentation

List all job offers.

Requirements

Name	Requirement	Type	Description
_format	xml\|json\|csv\|pdf\|html
make	[A-z]*

Return

Parameter	Type	Versions
[]	array of objects (JobOffers)	*
[][rmake_id]	string	*
[][url]	string	*
[][url_with_layout]	string	*
[][title]	string	*
[][publish_date]	DateTime	*
[][expiry_date]	DateTime	*
[][company]	string	*
[][location]	string	*
[][country]	string	*
[][country_region_id]	integer	*
[][country_region_name]	string	*
[][application_link]	string	*
[][company_description]	string	*
[][requirements]	string	*
[][opportunities]	string	*
[][notes]	string	*
[][clause]	string	*
[][experience]	string	*
[][job_offer_id]	integer	*
[][position_description]	string	*
[][last_modification_date]	DateTime	*
[][unique_id]	integer	*

Status Codes

Status Code	Description
200	Returned when successful

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/{make}/locations

GET /{make}/locations.{_format}

List all locations.

Documentation
Sandbox

Documentation

List all locations.

Requirements

Name	Requirement	Type	Description
_format	xml\|json\|csv\|pdf\|html
make	[A-z]*

Filters

Name

Information

offset

Requirement	\d+
Description	Offset from which to start listing locations.

limit

Requirement	\d+
Description	How many locations to return.
Default	200

filters

Requirement
Description	Filters

rmake

Requirement
Description	make

Return

Parameter	Type	Versions	Description
[]	array of objects (Location)	*
[][name]	string	*	Name.
[][street]	string	*	Street.
[][postalCode]		*
[][city]	object (City)	*	City.
[][city][otomoto_city_district_id]	integer	*	Otomoto City District id.
[][city][name]	string	*	Name.
[][city][text]	string	*	Text.
[][city][id]	integer	*
[][city][districts][]	array of objects (District)	*	Districts
[][shortname]	string	*	Short name.
[][postal_code]	string	*	Postal code.
[][district]	object (District)	*	District.
[][district][name]	string	*	Name.
[][district][id]	integer	*
[][country]	string	*	Country.
[][region]	string	*	Country.
[][phone]	string	*	Phone.
[][phone2]	string	*	Phone.
[][phone3]	string	*	Phone.
[][phone4]	string	*	Phone.
[][email]	string	*	Email.
[][email2]	string	*	Email.
[][email3]	string	*	Email.
[][email4]	string	*	Email.
[][www]	string	*	WWW.
[][longitude]	string	*	Longitude.
[][latitude]	string	*	Latitude.
[][type]	string	*	Type.
[][only_on_map]	boolean	*	Type.
[][description]	string	*	Description.
[][otomoto_description]	string	*	Otomoto Description.
[][active]	boolean	*	Active.
[][id]	integer	*

Status Codes

Status Code	Description
200	Returned when successful

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/{make}/locations/cities

GET /{make}/locations/cities.{_format}

List all cities names.

Documentation
Sandbox

Documentation

List all cities names.

Requirements

Name	Requirement	Type	Description
_format	xml\|json\|csv\|pdf\|html
make	[A-z]*

Filters

Name

Information

search

Requirement
Description	Search text.

offset

Requirement	\d+
Description	Offset from which to start listing locations.

limit

Requirement	\d+
Description	How many locations to return.
Default	25

Status Codes

Status Code	Description
200	Returned when successful

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/{make}/locations/districts

GET /{make}/locations/districts.{_format}

List all cities names.

Documentation
Sandbox

Documentation

List all cities names.

Requirements

Name	Requirement	Type	Description
_format	xml\|json\|csv\|pdf\|html
make	[A-z]*

Filters

Name

Information

search

Requirement
Description	Search text.

city

Requirement
Description	City district id

offset

Requirement	\d+
Description	Offset from which to start listing locations.

limit

Requirement	\d+
Description	How many locations to return.
Default	25

Status Codes

Status Code	Description
200	Returned when successful

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/{make}/locations/regions

GET /{make}/locations/regions.{_format}

List all region names.

Documentation
Sandbox

Documentation

List all region names.

Requirements

Name	Requirement	Type	Description
_format	xml\|json\|csv\|pdf\|html
make	[A-z]*

Status Codes

Status Code	Description
200	Returned when successful

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/{make}/locations/types

GET /{make}/locations/types.{_format}

List all Types names.

Documentation
Sandbox

Documentation

List all Types names.

Requirements

Name	Requirement	Type	Description
_format	xml\|json\|csv\|pdf\|html
make	[A-z]*

Status Codes

Status Code	Description
200	Returned when successful

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/{make}/posts

GET /{make}/posts.{_format}

List all posts.

Documentation
Sandbox

Documentation

List all posts.

Requirements

Name	Requirement	Type	Description
_format	xml\|json\|csv\|pdf\|html
make	[A-z]*

Filters

Name

Information

offset

Requirement	\d+
Description	Offset from which to start listing posts.

limit

Requirement	\d+
Description	How many posts to return.
Default	2000

filters

Requirement
Description	Filters

rmake

Requirement
Description	make

Return

Parameter	Type	Versions	Description
[]	array of objects (Post)	*
[][thumbnail]	integer	*	{@inheritdoc}
[][icon]	integer	*	{@inheritdoc}
[][category_id]	integer	*	Get category
[][title]	string	*	Name.
[][display_title]	string	*	Name.
[][subtitle]	string	*	Subtitle.
[][template]	string	*	Template.
[][meta_title]	string	*	Meta title.
[][meta_keywords]	string	*	Meta keywords.
[][meta_description]	string	*	Meta description.
[][created_at]	DateTime	*	Creation time.
[][updated_at]	DateTime	*	Update time.
[][active]	boolean	*	Active.
[][form]	boolean	*	With form.
[][button_1]	boolean	*	button.
[][button_2]	boolean	*	button.
[][button_3]	boolean	*	button.
[][make]	string	*	Make.
[][model]	string	*	Model.
[][mail_subject]	string	*	Mail Subject.
[][mail_to]	string	*	Mail Subject.
[][show_fafs]	boolean	*	Show files after form send.
[][category]	object (Category)	*
[][category][id]	integer	*
[][category][title]	string	*	Name.
[][category][slug]	string	*	Slug.
[][id]	integer	*
[][slug]	string	*	Slug.
[][excerpt]	string	*	Excerpt.
[][content]	string	*	Content.
[][thumb]	object (File)	*
[][thumb][user]	integer	*	{@inheritdoc}
[][thumb][type]	string	*	Type.
[][thumb][created_at]	DateTime	*	Creation time.
[][thumb][updated_at]	DateTime	*	Update time.
[][thumb][id]	integer	*
[][thumb][path]	string	*
[][thumb][description]	string	*
[][thumb][name]	string	*
[][thumb][mime_type]	string	*
[][thumb][size]	float	*
[][icon_thumb]	object (File)	*
[][form_html]	string	*	Form HTML.
[][form_text]	string	*	Form Text.
[][categories][]	array of objects (Category)	*
[][tags][]	array of objects (Tag)	*
[][tags][][id]	integer	*
[][tags][][title]	string	*	Name.
[][tags][][slug]	string	*	Slug.

Status Codes

Status Code	Description
200	Returned when successful

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/{make}/posts/cats/full

GET /{make}/posts/cats/full.{_format}

List all cats with posts.

Documentation
Sandbox

Documentation

List all cats with posts.

Requirements

Name	Requirement	Type	Description
_format	xml\|json\|csv\|pdf\|html
make	[A-z]*

Filters

Name

Information

search

Requirement
Description	Search text.

offset

Requirement	\d+
Description	Offset from which to start listing locations.

limit

Requirement	\d+
Description	How many locations to return.
Default	25

Status Codes

Status Code	Description
200	Returned when successful

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/{make}/posts/{id}

GET /{make}/posts/{id}.{_format}

Gets a Post for a given id

Documentation
Sandbox

Documentation

Get single Post.

Requirements

Name	Requirement	Type	Description
id	\d+	int	the post id
_format	xml\|json\|csv\|pdf\|html
make	[A-z]*

Filters

Name

Information

full

Requirement
Description	Full

Return

Parameter	Type	Versions	Description
thumbnail	integer	*	{@inheritdoc}
icon	integer	*	{@inheritdoc}
category_id	integer	*	Get category
title	string	*	Name.
display_title	string	*	Name.
subtitle	string	*	Subtitle.
template	string	*	Template.
meta_title	string	*	Meta title.
meta_keywords	string	*	Meta keywords.
meta_description	string	*	Meta description.
created_at	DateTime	*	Creation time.
updated_at	DateTime	*	Update time.
active	boolean	*	Active.
form	boolean	*	With form.
button_1	boolean	*	button.
button_2	boolean	*	button.
button_3	boolean	*	button.
make	string	*	Make.
model	string	*	Model.
mail_subject	string	*	Mail Subject.
mail_to	string	*	Mail Subject.
show_fafs	boolean	*	Show files after form send.
category	object (Category)	*
category[id]	integer	*
category[title]	string	*	Name.
category[slug]	string	*	Slug.
id	integer	*
slug	string	*	Slug.
excerpt	string	*	Excerpt.
content	string	*	Content.
thumb	object (File)	*
thumb[user]	integer	*	{@inheritdoc}
thumb[type]	string	*	Type.
thumb[created_at]	DateTime	*	Creation time.
thumb[updated_at]	DateTime	*	Update time.
thumb[id]	integer	*
thumb[path]	string	*
thumb[description]	string	*
thumb[name]	string	*
thumb[mime_type]	string	*
thumb[size]	float	*
thumb[file]		*
icon_thumb	object (File)	*
form_html	string	*	Form HTML.
form_text	string	*	Form Text.
categories[]	array of objects (Category)	*
tags[]	array of objects (Tag)	*
tags[][id]	integer	*
tags[][title]	string	*	Name.
tags[][slug]	string	*	Slug.

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when the post is not found

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

API

Usage:

1. Obtain the token:

2. Use token:

/{make}/attributes

GET /{make}/attributes.{_format}

Documentation

Requirements

Filters

Return

Status Codes

Requirements

Filters

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/{make}/attributes/types

GET /{make}/attributes/types.{_format}

Documentation

Requirements

Status Codes

Requirements

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/{make}/cars/list

GET /{make}/cars/list.{_format}

Documentation

Requirements

Filters

Return

Status Codes

Requirements

Filters

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/{make}/cars/simple

GET /{make}/cars/simple.{_format}

Documentation

Requirements

Filters

Return

Status Codes

Requirements

Filters

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/{make}/cars/statuses

GET /{make}/cars/statuses.{_format}

Documentation

Requirements

Status Codes

Requirements

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/{make}/job_offers

GET /{make}/job_offers.{_format}

Documentation

Requirements

Filters

Return

Status Codes

Requirements

Filters

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/{make}/job_offers/import

GET /{make}/job_offers/import.{_format}

Documentation

Requirements

Return

Status Codes

Requirements

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]