Introduction

Welcome to the Qebot API! The platform API follows a RESTful architecture that empowers developers to automate, extend and combine Qebot with other services.

We will have language bindings in Shell, PHP, Ruby, Python, Go, and JavaScript! Please check back to see if the language you use is available. You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

Authentication

Qebot uses an API key to allow access to the API. You can view your Qebot API key at your api key settings page (this is assuming you have a registered corporate admin account with Qebot).

Requests are authenticated using HTTP Basic Auth. Provide your API key as the basic auth password. Your agency email or user's username is the basic auth username. (Example: username:john.doe@example.com/
password:2mv6q24a8strw698327e50c3nba1fde929a187bb5bea0cd65436191f9475e360)

Errors

Our API returns standard HTTP success or error status codes.

In general: Codes in the 2xx range indicate success.

Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted).

Codes in the 5xx range indicate an error with Qebot's servers (e.g., server unavailability).

HTTP Status Codes

Code	Title	Description
200	OK	The request was successful.
204	OK	The request was successful with no body content.
400	Bad Request	The request was invalid or could not be understood by the server. This commonly occurs with faulty request encoding or empty requests in create actions.
401	Unauthorized	Your API key is missing or invalid.
403	Forbidden	The login is attempting to perform an action it does not have privileges to access. Verify your login credentials are for the appropriate account.
404	Not Found	The specified resource could not be found.
405	Method Not Allowed	You tried to access a resouce with an invalid method.
412	Precondition Failed	The request was unsuccessful because a condition was not met. For example, making a purchase on an inactive tool.
422	Validation	Could not process a POST, PUT, or PATCH request because the request is invalid.
500	Internal Server Error	We had a problem with our server. Try again later.
503	Service Unavailable	We're temporarily offline for maintenance. Please try again later.

Brands

A brand resource represents a franchise name. This object contains a hiearchy of businesses. For example if there is a McDonald's store in San Francisco and San Diego, the businesses would be the locations in San Francisco and San Diego and the brand would be McDonalds.

-- McDonalds brand |-- San Francisco McDonalds business |-- San Deigo McDonalds business

Brand Object

Attribute		Description
id	integer	Internal unique identifier for the object.
name	string	Name of the brand.

Retrieve A Brand List

GET /api/v1/brands

Example Request

# With shell, you can just pass the correct header with each request
curl "https://dev.qebot.com/api/v1/brands"
  -u "<USERNAME>:<API_TOKEN>"

Example Response

{
    "brands": [
        {
            "id": 1,
            "name": "Brand Name",
            "status": "active"
        },
        {...}
    ]
}

{
    "brands": [
        {
            "id": 1,
            "name": "Brand Name",
            "status": "active"
        },
        {...}
    ]
}

{
    "brands": [
        {
            "id": 1,
            "name": "Brand Name",
            "status": "active"
        },
        {...}
    ]
}

{
    "brands": [
        {
            "id": 1,
            "name": "Brand Name",
            "status": "active"
        },
        {...}
    ]
}

{
    "brands": [
        {
            "id": 1,
            "name": "Brand Name",
            "status": "active"
        },
        {...}
    ]
}

{
    "brands": [
        {
            "id": 1,
            "name": "Brand Name",
            "status": "active"
        },
        {...}
    ]
}

get

Retrieves a list of accessible brands.

HTTP Request

GET https://dev.qebot.com/api/v1/brands

Returns

Returns an array of brands.

Create Brand

POST /api/v1/brands

Example Request

# With shell, you can just pass the correct header with each request
curl "https://dev.qebot.com/api/v1/brands"
    -X POST
  -u "<USERNAME>:<API_TOKEN>"
  -d brand[name]="Brand Name"
  -d brand[status]=active
  -d businesses[][business_name]="Business Name"
  -d businesses[][category_id]=1
  -d businesses[][phone]=1234567890
  -d businesses[][fax]=1234567890
  -d businesses[][address]="123 fake st"
  -d businesses[][address2]="Suite #2"
  -d businesses[][city]="San Francisco"
  -d businesses[][state_id]=1
  -d businesses[][country_id]=1
  -d businesses[][zipcode]=12345
  -d businesses[][email]=user@example.com
  -d businesses[][website]="http://example.com"
  -d businesses[][status]=active

Example Response

{
    "brands": [
        {...}
    ],
    "businesses":[
        {...}
    ]
}

{
    "brands": [
        {...}
    ],
    "businesses":[
        {...}
    ]
}

{
    "brands": [
        {...}
    ],
    "businesses":[
        {...}
    ]
}

{
    "brands": [
        {...}
    ],
    "businesses":[
        {...}
    ]
}

{
    "brands": [
        {...}
    ],
    "businesses":[
        {...}
    ]
}

{
    "brands": [
        {...}
    ],
    "businesses":[
        {...}
    ]
}

post

Create a new brand with corresponding businesses.

HTTP Request

POST https://dev.qebot.com/api/v1/brands

Param		Description
brand.name `requried`	string	Name of brand or franchise.
brand.status `requried`	string	Status of brand. Possible values: (active, inactive)
businesses[]business	array	A business hash with an array of Business objects.
	business_name string `required`	Name of the business.
	category_id integer	Identifier for what category a business belongs to. See Category object
	phone string`required`	A phone contact number of the busieness.
	fax string	A fax number for the busieness.
	address string`required`	Address of the business.
	address2 string	Extra information for business address.
	city string`required`	City of the business.
	state_id integer	Extra information State identifier for the business. See State object
	state_name string	Name of the state where address resides.
	country_id integer`required`	Country identifier for the business. See Country object
	zipcode string`required`	Zipcode of the business.
	email string`required`	Contact email for the business.
	website string	Website for the business.
	status string	Status of the business. Possible values: (active, inactive)

Returns

Returns a hash with keys brands with an array of a brand and businesses with an array of bussinesses.

Retrieve Brand

GET /api/v1/brands/ id

Example Request

# With shell, you can just pass the correct header with each request
curl "https://dev.qebot.com/api/v1/brands/<ID>"
  -u "<USERNAME>:<API_TOKEN>"

Example Response

{
    "brands": [
        {
            "id": 1,
            "name": "Brand Name",
            "status": "active"
        }
    ]
}

{
    "brands": [
        {
            "id": 1,
            "name": "Brand Name",
            "status": "active"
        }
    ]
}

{
    "brands": [
        {
            "id": 1,
            "name": "Brand Name",
            "status": "active"
        }
    ]
}

{
    "brands": [
        {
            "id": 1,
            "name": "Brand Name",
            "status": "active"
        }
    ]
}

{
    "brands": [
        {
            "id": 1,
            "name": "Brand Name",
            "status": "active"
        }
    ]
}

{
    "brands": [
        {
            "id": 1,
            "name": "Brand Name",
            "status": "active"
        }
    ]
}

get

Retrieves a brand from a previously created brand object.

To retrieve a brand object you must supply the uniqe identifier id to brand's resouce link /api/v1/brands/ id

HTTP Request

GET https://dev.qebot.com/api/v1/brands/<ID>

Returns

Returns an array of a brand.

Update Brand

PUT /api/v1/brands/ id

PATCH /api/v1/brands/ id

Example Request

# Brand id needs to be appended after api uri
curl "https://dev.qebot.com/api/v1/brands/<ID>"
    -X PATCH
  -u "<USERNAME>:<API_TOKEN>"
  -d name="Brand Name"
  -d status=active

Example Response

{
    "brands": [
        {
            "id": 1,
            "name": "Brand Name",
            "status": "active"
        }
    ]
}

{
    "brands": [
        {
            "id": 1,
            "name": "Brand Name",
            "status": "active"
        }
    ]
}

{
    "brands": [
        {
            "id": 1,
            "name": "Brand Name",
            "status": "active"
        }
    ]
}

{
    "brands": [
        {
            "id": 1,
            "name": "Brand Name",
            "status": "active"
        }
    ]
}

{
    "brands": [
        {
            "id": 1,
            "name": "Brand Name",
            "status": "active"
        }
    ]
}

{
    "brands": [
        {
            "id": 1,
            "name": "Brand Name",
            "status": "active"
        }
    ]
}

post post

Updates a brand object.

To update a brand object you must supply the uniqe identifier id to brand's resouce link /api/v1/brands/ id

HTTP Request

PUT https://dev.qebot.com/api/v1/brands/<ID>

PATCH https://dev.qebot.com/api/v1/brands/<ID>

Param		Description
name	string	Name of brand or franchise.
status	string	Status of brand. Possible values: (active, inactive)

Returns

Returns an array of a brand.

Delete Brand

DELETE /api/v1/brands/ id

Example Request

# Brand id needs to be appended after api uri
curl "https://dev.qebot.com/api/v1/brands/<ID>"
    -X PATCH
  -u "<USERNAME>:<API_TOKEN>"

Example Response

delete

Deletes a brand object.

To delete a brand object you must supply the uniqe identifier id to brand's resouce link /api/v1/brands/ id

HTTP Request

DELETE https://dev.qebot.com/api/v1/brands/<ID>

Returns

Returns an empty response.

Businesses

Businesses are core to managing your franchises inside of Qebot. The Business object stores data not only about business information, but also information that dictates how purchases are made.

Business Object

Attribute		Description
id	integer	Internal unique identifier for the object.
business_name	string	Name of the business.
category	Category	See Category object
phone	string	A phone contact number of the busieness.
fax	string	A fax number for the busieness.
address	string	Address of the business.
address2	string	Extra information for business address.
city	string	City of the business.
state_id	State	See State object
state	string	Name of the state where address resides.
country	Country	See Country object
zipcode	string	Zipcode of the business.
email	string	Contact email for the business.
website	string	Website for the business.
status	string	Status of the business. Possible values: (active, inactive)

Category Object

Attribute		Description
id	integer	Internal unique identifier for the object.
name	string	Name of the category.
description	string	Description of category.

Possible Categories

Categories id 1 name Accounting description Accounting id 2 name Advertising description Advertising id 3 name Aerospace description Aerospace id 4 name Agriculture description Agriculture id 5 name Aircraft description Aircraft id 6 name Airline description Airline id 7 name Apparel description Apparel id 8 name Automotive description Automotive id 9 name Banking description Banking id 10 name Biotechnology description Biotechnology id 11 name Broadcasting description Broadcasting id 12 name Brokerage description Brokerage id 13 name Business Support & Supplies description Business Support & Supplies id 14 name Call Centers description Call Centers id 15 name Cargo Handling description Cargo Handling id 16 name Chemicals description Chemicals id 17 name Communications description Communications id 18 name Computers & Electronics description Computers & Electronics id 19 name Consumer Products description Consumer Products id 20 name Cosmetics description Cosmetics id 21 name Construction description Construction id 22 name Consulting description Consulting id 23 name Defense description Defense id 24 name Department Stores description Department Stores id 25 name Education description Education id 26 name Electronics description Electronics id 27 name Energy description Energy id 28 name Engineering description Engineering id 29 name Entertainment description Entertainment id 30 name Environmental description Environmental id 31 name Executive Search description Executive Search id 32 name Finance description Finance id 33 name Food & Beverage description Food & Beverage id 34 name Government description Government id 35 name Grocery description Grocery id 36 name Healthcare description Healthcare id 37 name Home & Garden description Home & Garden id 38 name Hospitality description Hospitality id 39 name Insurance description Insurance id 40 name Internet Publishing description Internet Publishing id 41 name Investment Banking description Investment Banking id 42 name Legal description Legal id 43 name Machinery description Machinery id 44 name Manufacturing description Manufacturing id 45 name Media description Media id 46 name Merchants description Merchants id 47 name Motion Picture & Video description Motion Picture & Video id 48 name Music description Music id 49 name Newspaper Publishers description Newspaper Publishers id 50 name Not For Profit description Not For Profit id 51 name Online Auctions description Online Auctions id 52 name Other description Other id 53 name Pension Funds description Pension Funds id 54 name Personal Care description Personal Care id 55 name Pharmaceuticals description Pharmaceuticals id 56 name Private Equity description Private Equity id 57 name Publishing description Publishing id 58 name Real Estate description Real Estate id 59 name Recreation description Recreation id 60 name Retail description Retail id 61 name Securities & Commodity Exchanges description Securities & Commodity Exchanges id 62 name Service description Service id 63 name Shipping description Shipping id 64 name Soap & Detergent description Soap & Detergent id 65 name Software description Software id 66 name Technology description Technology id 67 name Telecommunications description Telecommunications id 68 name Transportation description Transportation id 69 name Utilities description Utilities id 70 name Health and Fitness description Health and Fitness

Country Object

Attribute		Description
id	integer	Internal unique identifier for the object.
code	string	Two letter country code.
country	string	Name of the Country

Possible Countries

Countries id 1 code AF Country Afghanistan id 2 code AL Country Albania id 3 code DZ Country Algeria id 4 code DS Country American Samoa id 5 code AD Country Andorra id 6 code AO Country Angola id 7 code AI Country Anguilla id 8 code AQ Country Antarctica id 9 code AG Country Antigua and Barbuda id 10 code AR Country Argentina id 11 code AM Country Armenia id 12 code AW Country Aruba id 13 code AU Country Australia id 14 code AT Country Austria id 15 code AZ Country Azerbaijan id 16 code BS Country Bahamas id 17 code BH Country Bahrain id 18 code BD Country Bangladesh id 19 code BB Country Barbados id 20 code BY Country Belarus id 21 code BE Country Belgium id 22 code BZ Country Belize id 23 code BJ Country Benin id 24 code BM Country Bermuda id 25 code BT Country Bhutan id 26 code BO Country Bolivia id 27 code BA Country Bosnia and Herzegovina id 28 code BW Country Botswana id 29 code BV Country Bouvet Island id 30 code BR Country Brazil id 31 code IO Country British Indian Ocean Territory id 32 code BN Country Brunei Darussalam id 33 code BG Country Bulgaria id 34 code BF Country Burkina Faso id 35 code BI Country Burundi id 36 code KH Country Cambodia id 37 code CM Country Cameroon id 38 code CA Country Canada id 39 code CV Country Cape Verde id 40 code KY Country Cayman Islands id 41 code CF Country Central African Republic id 42 code TD Country Chad id 43 code CL Country Chile id 44 code CN Country China id 45 code CX Country Christmas Island id 46 code CC Country Cocos (Keeling) Islands id 47 code CO Country Colombia id 48 code KM Country Comoros id 49 code CG Country Congo id 50 code CK Country Cook Islands id 51 code CR Country Costa Rica id 52 code HR Country Croatia (Hrvatska) id 53 code CU Country Cuba id 54 code CY Country Cyprus id 55 code CZ Country Czech Republic id 56 code DK Country Denmark id 57 code DJ Country Djibouti id 58 code DM Country Dominica id 59 code DO Country Dominican Republic id 60 code TP Country East Timor id 61 code EC Country Ecuador id 62 code EG Country Egypt id 63 code SV Country El Salvador id 64 code GQ Country Equatorial Guinea id 65 code ER Country Eritrea id 66 code EE Country Estonia id 67 code ET Country Ethiopia id 68 code FK Country Falkland Islands (Malvinas) id 69 code FO Country Faroe Islands id 70 code FJ Country Fiji id 71 code FI Country Finland id 72 code FR Country France id 73 code FX Country France, Metropolitan id 74 code GF Country French Guiana id 75 code PF Country French Polynesia id 76 code TF Country French Southern Territories id 77 code GA Country Gabon id 78 code GM Country Gambia id 79 code GE Country Georgia id 80 code DE Country Germany id 81 code GH Country Ghana id 82 code GI Country Gibraltar id 83 code GK Country Guernsey id 84 code GR Country Greece id 85 code GL Country Greenland id 86 code GD Country Grenada id 87 code GP Country Guadeloupe id 88 code GU Country Guam id 89 code GT Country Guatemala id 90 code GN Country Guinea id 91 code GW Country Guinea-Bissau id 92 code GY Country Guyana id 93 code HT Country Haiti id 94 code HM Country Heard and Mc Donald Islands id 95 code HN Country Honduras id 96 code HK Country Hong Kong id 97 code HU Country Hungary id 98 code IS Country Iceland id 99 code IN Country India id 100 code IM Country Isle of Man id 101 code ID Country Indonesia id 102 code IR Country Iran (Islamic Republic of) id 103 code IQ Country Iraq id 104 code IE Country Ireland id 105 code IL Country Israel id 106 code IT Country Italy id 107 code CI Country Ivory Coast id 108 code JE Country Jersey id 109 code JM Country Jamaica id 110 code JP Country Japan id 111 code JO Country Jordan id 112 code KZ Country Kazakhstan id 113 code KE Country Kenya id 114 code KI Country Kiribati id 115 code KP Country Korea, Democratic People's Republic of id 116 code KR Country Korea, Republic of id 117 code XK Country Kosovo id 118 code KW Country Kuwait id 119 code KG Country Kyrgyzstan id 120 code LA Country Lao People's Democratic Republic id 121 code LV Country Latvia id 122 code LB Country Lebanon id 123 code LS Country Lesotho id 124 code LR Country Liberia id 125 code LY Country Libyan Arab Jamahiriya id 126 code LI Country Liechtenstein id 127 code LT Country Lithuania id 128 code LU Country Luxembourg id 129 code MO Country Macau id 130 code MK Country Macedonia id 131 code MG Country Madagascar id 132 code MW Country Malawi id 133 code MY Country Malaysia id 134 code MV Country Maldives id 135 code ML Country Mali id 136 code MT Country Malta id 137 code MH Country Marshall Islands id 138 code MQ Country Martinique id 139 code MR Country Mauritania id 140 code MU Country Mauritius id 141 code TY Country Mayotte id 142 code MX Country Mexico id 143 code FM Country Micronesia, Federated States of id 144 code MD Country Moldova, Republic of id 145 code MC Country Monaco id 146 code MN Country Mongolia id 147 code ME Country Montenegro id 148 code MS Country Montserrat id 149 code MA Country Morocco id 150 code MZ Country Mozambique id 151 code MM Country Myanmar id 152 code NA Country Namibia id 153 code NR Country Nauru id 154 code NP Country Nepal id 155 code NL Country Netherlands id 156 code AN Country Netherlands Antilles id 157 code NC Country New Caledonia id 158 code NZ Country New Zealand id 159 code NI Country Nicaragua id 160 code NE Country Niger id 161 code NG Country Nigeria id 162 code NU Country Niue id 163 code NF Country Norfolk Island id 164 code MP Country Northern Mariana Islands id 165 code NO Country Norway id 166 code OM Country Oman id 167 code PK Country Pakistan id 168 code PW Country Palau id 169 code PS Country Palestine id 170 code PA Country Panama id 171 code PG Country Papua New Guinea id 172 code PY Country Paraguay id 173 code PE Country Peru id 174 code PH Country Philippines id 175 code PN Country Pitcairn id 176 code PL Country Poland id 177 code PT Country Portugal id 178 code PR Country Puerto Rico id 179 code QA Country Qatar id 180 code RE Country Reunion id 181 code RO Country Romania id 182 code RU Country Russian Federation id 183 code RW Country Rwanda id 184 code KN Country Saint Kitts and Nevis id 185 code LC Country Saint Lucia id 186 code VC Country Saint Vincent and the Grenadines id 187 code WS Country Samoa id 188 code SM Country San Marino id 189 code ST Country Sao Tome and Principe id 190 code SA Country Saudi Arabia id 191 code SN Country Senegal id 192 code RS Country Serbia id 193 code SC Country Seychelles id 194 code SL Country Sierra Leone id 195 code SG Country Singapore id 196 code SK Country Slovakia id 197 code SI Country Slovenia id 198 code SB Country Solomon Islands id 199 code SO Country Somalia id 200 code ZA Country South Africa id 201 code GS Country South Georgia South Sandwich Islands id 202 code ES Country Spain id 203 code LK Country Sri Lanka id 204 code SH Country St. Helena id 205 code PM Country St. Pierre and Miquelon id 206 code SD Country Sudan id 207 code SR Country Suriname id 208 code SJ Country Svalbard and Jan Mayen Islands id 209 code SZ Country Swaziland id 210 code SE Country Sweden id 211 code CH Country Switzerland id 212 code SY Country Syrian Arab Republic id 213 code TW Country Taiwan id 214 code TJ Country Tajikistan id 215 code TZ Country Tanzania, United Republic of id 216 code TH Country Thailand id 217 code TG Country Togo id 218 code TK Country Tokelau id 219 code TO Country Tonga id 220 code TT Country Trinidad and Tobago id 221 code TN Country Tunisia id 222 code TR Country Turkey id 223 code TM Country Turkmenistan id 224 code TC Country Turks and Caicos Islands id 225 code TV Country Tuvalu id 226 code UG Country Uganda id 227 code UA Country Ukraine id 228 code AE Country United Arab Emirates id 229 code GB Country United Kingdom id 230 code US Country United States id 231 code UM Country United States minor outlying islands id 232 code UY Country Uruguay id 233 code UZ Country Uzbekistan id 234 code VU Country Vanuatu id 235 code VA Country Vatican City State id 236 code VE Country Venezuela id 237 code VN Country Vietnam id 238 code VG Country Virgin Islands (British) id 239 code VI Country Virgin Islands (U.S.) id 240 code WF Country Wallis and Futuna Islands id 241 code EH Country Western Sahara id 242 code YE Country Yemen id 243 code ZR Country Zaire id 244 code ZM Country Zambia id 245 code ZW Country Zimbabwe

State Object

Attribute		Description
id	integer	Internal unique identifier for the object.
name	string	Name of the state.
abbr	string	Two letter United States state code.

Possible States

States id 1 name Alabama abbr AL id 2 name Alaska abbr AK id 3 name Arizona abbr AZ id 4 name Arkansas abbr AR id 5 name California abbr CA id 6 name Colorado abbr CO id 7 name Connecticut abbr CT id 8 name Delaware abbr DE id 9 name Florida abbr FL id 10 name Georgia abbr GA id 11 name Hawaii abbr HI id 12 name Idaho abbr ID id 13 name Illinois abbr IL id 14 name Indiana abbr IN id 15 name Iowa abbr IA id 16 name Kansas abbr KS id 17 name Kentucky abbr KY id 18 name Louisiana abbr LA id 19 name Maine abbr ME id 20 name Maryland abbr MD id 21 name Massachusetts abbr MA id 22 name Michigan abbr MI id 23 name Minnesota abbr MN id 24 name Mississippi abbr MS id 25 name Missouri abbr MO id 26 name Montana abbr MT id 27 name Nebraska abbr NE id 28 name Nevada abbr NV id 29 name New Hampshire abbr NH id 30 name New Jersey abbr NJ id 31 name New Mexico abbr NM id 32 name New York abbr NY id 33 name North Carolina abbr NC id 34 name North Dakota abbr ND id 35 name Ohio abbr OH id 36 name Oklahoma abbr OK id 37 name Oregon abbr OR id 38 name Pennsylvania abbr PA id 39 name Rhode Island abbr RI id 40 name South Carolina abbr SC id 41 name South Dakota abbr SD id 42 name Tennessee abbr TN id 43 name Texas abbr TX id 44 name Utah abbr UT id 45 name Vermont abbr VT id 46 name Virginia abbr VA id 47 name Washington abbr WA id 48 name West Virginia abbr WV id 49 name Wisconsin abbr WI id 50 name Wyoming WY

Retrieve A Business List

GET /api/v1/businesses

Example Request

# With shell, you can just pass the correct header with each request
curl "https://dev.qebot.com/api/v1/businesses"
  -u "<USERNAME>:<API_TOKEN>"

Example Response

{
    "businesses": [
        {
            "id": 1,
            "brand_id": 1,
            "business_name": "Business Name",
            "phone": "123456789",
            "fax": "123456789",
            "address": "123 Fake St",
            "address2": "",
            "city": "San Francisco",
            "state_name": "",
            "zipcode": "12345",
            "email": "john.doe@example.com",
            "website": "http://example.om",
            "status": "active",
            "category": {
                "id": 52,
                "name": "Other",
                "description": "Other"
            },
            "country": {
                "id": 230,
                "code": "US",
                "country": "United States"
            },
            "state": {
                "id": 5,
                "name": "California",
                "abbr": "CA",
                "description": "California"
            }
        },
        {...}
    ]
}

{
    "brands": [
        {
            "id": 1,
            "brand_id": 1,
            "business_name": "Business Name",
            "phone": "123456789",
            "fax": "123456789",
            "address": "123 Fake St",
            "address2": "",
            "city": "San Francisco",
            "state_name": "",
            "zipcode": "12345",
            "email": "john.doe@example.com",
            "website": "http://example.om",
            "status": "active",
            "category": {
                "id": 52,
                "name": "Other",
                "description": "Other"
            },
            "country": {
                "id": 230,
                "code": "US",
                "country": "United States"
            },
            "state": {
                "id": 5,
                "name": "California",
                "abbr": "CA",
                "description": "California"
            }
        },
        {...}
    ]
}

{
    "businesses": [
        {
            "id": 1,
            "brand_id": 1,
            "business_name": "Business Name",
            "phone": "123456789",
            "fax": "123456789",
            "address": "123 Fake St",
            "address2": "",
            "city": "San Francisco",
            "state_name": "",
            "zipcode": "12345",
            "email": "john.doe@example.com",
            "website": "http://example.om",
            "status": "active",
            "category": {
                "id": 52,
                "name": "Other",
                "description": "Other"
            },
            "country": {
                "id": 230,
                "code": "US",
                "country": "United States"
            },
            "state": {
                "id": 5,
                "name": "California",
                "abbr": "CA",
                "description": "California"
            }
        },
        {...}
    ]
}

{
    "businesses": [
        {
            "id": 1,
            "brand_id": 1,
            "business_name": "Business Name",
            "phone": "123456789",
            "fax": "123456789",
            "address": "123 Fake St",
            "address2": "",
            "city": "San Francisco",
            "state_name": "",
            "zipcode": "12345",
            "email": "john.doe@example.com",
            "website": "http://example.om",
            "status": "active",
            "category": {
                "id": 52,
                "name": "Other",
                "description": "Other"
            },
            "country": {
                "id": 230,
                "code": "US",
                "country": "United States"
            },
            "state": {
                "id": 5,
                "name": "California",
                "abbr": "CA",
                "description": "California"
            }
        },
        {...}
    ]
}

{
    "businesses": [
        {
            "id": 1,
            "brand_id": 1,
            "business_name": "Business Name",
            "phone": "123456789",
            "fax": "123456789",
            "address": "123 Fake St",
            "address2": "",
            "city": "San Francisco",
            "state_name": "",
            "zipcode": "12345",
            "email": "john.doe@example.com",
            "website": "http://example.om",
            "status": "active",
            "category": {
                "id": 52,
                "name": "Other",
                "description": "Other"
            },
            "country": {
                "id": 230,
                "code": "US",
                "country": "United States"
            },
            "state": {
                "id": 5,
                "name": "California",
                "abbr": "CA",
                "description": "California"
            }
        },
        {...}
    ]
}

{
    "businesses": [
        {
            "id": 1,
            "brand_id": 1,
            "business_name": "Business Name",
            "phone": "123456789",
            "fax": "123456789",
            "address": "123 Fake St",
            "address2": "",
            "city": "San Francisco",
            "state_name": "",
            "zipcode": "12345",
            "email": "john.doe@example.com",
            "website": "http://example.om",
            "status": "active",
            "category": {
                "id": 52,
                "name": "Other",
                "description": "Other"
            },
            "country": {
                "id": 230,
                "code": "US",
                "country": "United States"
            },
            "state": {
                "id": 5,
                "name": "California",
                "abbr": "CA",
                "description": "California"
            }
        },
        {...}
    ]
}

get

Retrieves a list of accessible brands.

HTTP Request

GET https://dev.qebot.com/api/v1/brands

Returns

Returns an array of businesses.

Create Business

POST /api/v1/businesses

Example Request

# With shell, you can just pass the correct header with each request
curl "https://dev.qebot.com/api/v1/businesses"
  -X POST
  -u "<USERNAME>:<API_TOKEN>"
  -d business_name="Business Name"
  -d category_id=1
  -d phone=1234567890
  -d fax=1234567890
  -d address="123 fake st"
  -d address2="Suite #2"
  -d city="San Francisco"
  -d state_id=1
  -d country_id=1
  -d zipcode=12345
  -d email=user@example.com
  -d website="http://example.com"
  -d status=active

Example Response

{
    "businesses":[
        {
            "id": 1,
            "brand_id": 1,
            "business_name": "Business Name",
            "phone": "123456789",
            "fax": "123456789",
            "address": "123 Fake St",
            "address2": "",
            "city": "San Francisco",
            "state_name": "",
            "zipcode": "12345",
            "email": "john.doe@example.com",
            "website": "http://example.om",
            "status": "active",
            "category": {
                "id": 52,
                "name": "Other",
                "description": "Other"
            },
            "country": {
                "id": 230,
                "code": "US",
                "country": "United States"
            },
            "state": {
                "id": 5,
                "name": "California",
                "abbr": "CA",
                "description": "California"
            }
        }
    ]
}

{
    "businesses":[
        {
            "id": 1,
            "brand_id": 1,
            "business_name": "Business Name",
            "phone": "123456789",
            "fax": "123456789",
            "address": "123 Fake St",
            "address2": "",
            "city": "San Francisco",
            "state_name": "",
            "zipcode": "12345",
            "email": "john.doe@example.com",
            "website": "http://example.om",
            "status": "active",
            "category": {
                "id": 52,
                "name": "Other",
                "description": "Other"
            },
            "country": {
                "id": 230,
                "code": "US",
                "country": "United States"
            },
            "state": {
                "id": 5,
                "name": "California",
                "abbr": "CA",
                "description": "California"
            }
        }
    ]
}

{
    "businesses":[
        {
            "id": 1,
            "brand_id": 1,
            "business_name": "Business Name",
            "phone": "123456789",
            "fax": "123456789",
            "address": "123 Fake St",
            "address2": "",
            "city": "San Francisco",
            "state_name": "",
            "zipcode": "12345",
            "email": "john.doe@example.com",
            "website": "http://example.om",
            "status": "active",
            "category": {
                "id": 52,
                "name": "Other",
                "description": "Other"
            },
            "country": {
                "id": 230,
                "code": "US",
                "country": "United States"
            },
            "state": {
                "id": 5,
                "name": "California",
                "abbr": "CA",
                "description": "California"
            }
        }
    ]
}

{
    "businesses":[
        {
            "id": 1,
            "brand_id": 1,
            "business_name": "Business Name",
            "phone": "123456789",
            "fax": "123456789",
            "address": "123 Fake St",
            "address2": "",
            "city": "San Francisco",
            "state_name": "",
            "zipcode": "12345",
            "email": "john.doe@example.com",
            "website": "http://example.om",
            "status": "active",
            "category": {
                "id": 52,
                "name": "Other",
                "description": "Other"
            },
            "country": {
                "id": 230,
                "code": "US",
                "country": "United States"
            },
            "state": {
                "id": 5,
                "name": "California",
                "abbr": "CA",
                "description": "California"
            }
        }
    ]
}

{
    "businesses":[
        {
            "id": 1,
            "brand_id": 1,
            "business_name": "Business Name",
            "phone": "123456789",
            "fax": "123456789",
            "address": "123 Fake St",
            "address2": "",
            "city": "San Francisco",
            "state_name": "",
            "zipcode": "12345",
            "email": "john.doe@example.com",
            "website": "http://example.om",
            "status": "active",
            "category": {
                "id": 52,
                "name": "Other",
                "description": "Other"
            },
            "country": {
                "id": 230,
                "code": "US",
                "country": "United States"
            },
            "state": {
                "id": 5,
                "name": "California",
                "abbr": "CA",
                "description": "California"
            }
        }
    ]
}

{
    "businesses":[
        {
            "id": 1,
            "brand_id": 1,
            "business_name": "Business Name",
            "phone": "123456789",
            "fax": "123456789",
            "address": "123 Fake St",
            "address2": "",
            "city": "San Francisco",
            "state_name": "",
            "zipcode": "12345",
            "email": "john.doe@example.com",
            "website": "http://example.om",
            "status": "active",
            "category": {
                "id": 52,
                "name": "Other",
                "description": "Other"
            },
            "country": {
                "id": 230,
                "code": "US",
                "country": "United States"
            },
            "state": {
                "id": 5,
                "name": "California",
                "abbr": "CA",
                "description": "California"
            }
        }
    ]
}

post

Create a new business.

HTTP Request

POST https://dev.qebot.com/api/v1/businesses

Attribute		Description
business_name	string`required`	Name of the business.
brand_id	integer`required`	Unique identifier of brand associated with the business.
category_id	integer`required`	Identifier for what category a business belongs to. See Category object
phone	string	A phone contact number of the busieness.
fax	string	A fax number for the busieness.
address	string`required`	Address of the business.
address2	string	Extra information for business address.
city	string`required`	City of the business.
state_id	integer	Extra information State identifier for the business. See State object
state_name	string	Name of the state where address resides.
country_id	integer`required`	Country identifier for the business. See Country object
zipcode	string`required`	Zipcode of the business.
email	string`required`	Contact email for the business.
website	string	Website for the business.
status	string`required`	Status of the business. Possible values: (active, inactive)

Returns

Returns an array of a business.

Retrieve Business

GET /api/v1/brands/ id

Example Request

# With shell, you can just pass the correct header with each request
curl "https://dev.qebot.com/api/v1/brands/<ID>"
  -u "<USERNAME>:<API_TOKEN>"

Example Response

{
    "businesses": [
        {
            "id": 1,
            "brand_id": 1,
            "business_name": "Business Name",
            "phone": "123456789",
            "fax": "123456789",
            "address": "123 Fake St",
            "address2": "",
            "city": "San Francisco",
            "state_name": "",
            "zipcode": "12345",
            "email": "john.doe@example.com",
            "website": "http://example.om",
            "status": "active",
            "category": {
                "id": 52,
                "name": "Other",
                "description": "Other"
            },
            "country": {
                "id": 230,
                "code": "US",
                "country": "United States"
            },
            "state": {
                "id": 5,
                "name": "California",
                "abbr": "CA",
                "description": "California"
            }
        }
    ]
}

{
    "businesses": [
        {
            "id": 1,
            "brand_id": 1,
            "business_name": "Business Name",
            "phone": "123456789",
            "fax": "123456789",
            "address": "123 Fake St",
            "address2": "",
            "city": "San Francisco",
            "state_name": "",
            "zipcode": "12345",
            "email": "john.doe@example.com",
            "website": "http://example.om",
            "status": "active",
            "category": {
                "id": 52,
                "name": "Other",
                "description": "Other"
            },
            "country": {
                "id": 230,
                "code": "US",
                "country": "United States"
            },
            "state": {
                "id": 5,
                "name": "California",
                "abbr": "CA",
                "description": "California"
            }
        }
    ]
}

{
    "businesses": [
        {
            "id": 1,
            "brand_id": 1,
            "business_name": "Business Name",
            "phone": "123456789",
            "fax": "123456789",
            "address": "123 Fake St",
            "address2": "",
            "city": "San Francisco",
            "state_name": "",
            "zipcode": "12345",
            "email": "john.doe@example.com",
            "website": "http://example.om",
            "status": "active",
            "category": {
                "id": 52,
                "name": "Other",
                "description": "Other"
            },
            "country": {
                "id": 230,
                "code": "US",
                "country": "United States"
            },
            "state": {
                "id": 5,
                "name": "California",
                "abbr": "CA",
                "description": "California"
            }
        }
    ]
}

{
    "businesses": [
        {
            "id": 1,
            "brand_id": 1,
            "business_name": "Business Name",
            "phone": "123456789",
            "fax": "123456789",
            "address": "123 Fake St",
            "address2": "",
            "city": "San Francisco",
            "state_name": "",
            "zipcode": "12345",
            "email": "john.doe@example.com",
            "website": "http://example.om",
            "status": "active",
            "category": {
                "id": 52,
                "name": "Other",
                "description": "Other"
            },
            "country": {
                "id": 230,
                "code": "US",
                "country": "United States"
            },
            "state": {
                "id": 5,
                "name": "California",
                "abbr": "CA",
                "description": "California"
            }
        }
    ]
}

{
    "businesses": [
        {
            "id": 1,
            "brand_id": 1,
            "business_name": "Business Name",
            "phone": "123456789",
            "fax": "123456789",
            "address": "123 Fake St",
            "address2": "",
            "city": "San Francisco",
            "state_name": "",
            "zipcode": "12345",
            "email": "john.doe@example.com",
            "website": "http://example.om",
            "status": "active",
            "category": {
                "id": 52,
                "name": "Other",
                "description": "Other"
            },
            "country": {
                "id": 230,
                "code": "US",
                "country": "United States"
            },
            "state": {
                "id": 5,
                "name": "California",
                "abbr": "CA",
                "description": "California"
            }
        }
    ]
}

{
    "businesses": [
        {
            "id": 1,
            "brand_id": 1,
            "business_name": "Business Name",
            "phone": "123456789",
            "fax": "123456789",
            "address": "123 Fake St",
            "address2": "",
            "city": "San Francisco",
            "state_name": "",
            "zipcode": "12345",
            "email": "john.doe@example.com",
            "website": "http://example.om",
            "status": "active",
            "category": {
                "id": 52,
                "name": "Other",
                "description": "Other"
            },
            "country": {
                "id": 230,
                "code": "US",
                "country": "United States"
            },
            "state": {
                "id": 5,
                "name": "California",
                "abbr": "CA",
                "description": "California"
            }
        }
    ]
}

get

Retrieves a business from a previously created business object.

To retrieve a business object you must supply the uniqe identifier id to business's resouce link /api/v1/businesses/ id

HTTP Request

GET https://dev.qebot.com/api/v1/businesses/<ID>

Returns

Returns an array of a business.

Update Business

PUT /api/v1/businesses/ id

PATCH /api/v1/businesses/ id

Example Request

# Brand id needs to be appended after api uri
curl "https://dev.qebot.com/api/v1/businesses/<ID>"
  -X PATCH
  -u "<USERNAME>:<API_TOKEN>"
  -d business_name="Business Name"
  -d status=active

Example Response

{
    "businesses": [
        {
            "id": 1,
            "brand_id": 1,
            "business_name": "Business Name",
            "phone": "123456789",
            "fax": "123456789",
            "address": "123 Fake St",
            "address2": "",
            "city": "San Francisco",
            "state_name": "",
            "zipcode": "12345",
            "email": "john.doe@example.com",
            "website": "http://example.om",
            "status": "active",
            "category": {
                "id": 52,
                "name": "Other",
                "description": "Other"
            },
            "country": {
                "id": 230,
                "code": "US",
                "country": "United States"
            },
            "state": {
                "id": 5,
                "name": "California",
                "abbr": "CA",
                "description": "California"
            }
        }
    ]
}

{
    "businesses": [
        {
            "id": 1,
            "brand_id": 1,
            "business_name": "Business Name",
            "phone": "123456789",
            "fax": "123456789",
            "address": "123 Fake St",
            "address2": "",
            "city": "San Francisco",
            "state_name": "",
            "zipcode": "12345",
            "email": "john.doe@example.com",
            "website": "http://example.om",
            "status": "active",
            "category": {
                "id": 52,
                "name": "Other",
                "description": "Other"
            },
            "country": {
                "id": 230,
                "code": "US",
                "country": "United States"
            },
            "state": {
                "id": 5,
                "name": "California",
                "abbr": "CA",
                "description": "California"
            }
        }
    ]
}

{
    "businesses": [
        {
            "id": 1,
            "brand_id": 1,
            "business_name": "Business Name",
            "phone": "123456789",
            "fax": "123456789",
            "address": "123 Fake St",
            "address2": "",
            "city": "San Francisco",
            "state_name": "",
            "zipcode": "12345",
            "email": "john.doe@example.com",
            "website": "http://example.om",
            "status": "active",
            "category": {
                "id": 52,
                "name": "Other",
                "description": "Other"
            },
            "country": {
                "id": 230,
                "code": "US",
                "country": "United States"
            },
            "state": {
                "id": 5,
                "name": "California",
                "abbr": "CA",
                "description": "California"
            }
        }
    ]
}

{
    "businesses": [
        {
            "id": 1,
            "brand_id": 1,
            "business_name": "Business Name",
            "phone": "123456789",
            "fax": "123456789",
            "address": "123 Fake St",
            "address2": "",
            "city": "San Francisco",
            "state_name": "",
            "zipcode": "12345",
            "email": "john.doe@example.com",
            "website": "http://example.om",
            "status": "active",
            "category": {
                "id": 52,
                "name": "Other",
                "description": "Other"
            },
            "country": {
                "id": 230,
                "code": "US",
                "country": "United States"
            },
            "state": {
                "id": 5,
                "name": "California",
                "abbr": "CA",
                "description": "California"
            }
        }
    ]
}

{
    "businesses": [
        {
            "id": 1,
            "brand_id": 1,
            "business_name": "Business Name",
            "phone": "123456789",
            "fax": "123456789",
            "address": "123 Fake St",
            "address2": "",
            "city": "San Francisco",
            "state_name": "",
            "zipcode": "12345",
            "email": "john.doe@example.com",
            "website": "http://example.om",
            "status": "active",
            "category": {
                "id": 52,
                "name": "Other",
                "description": "Other"
            },
            "country": {
                "id": 230,
                "code": "US",
                "country": "United States"
            },
            "state": {
                "id": 5,
                "name": "California",
                "abbr": "CA",
                "description": "California"
            }
        }
    ]
}

{
    "businesses": [
        {
            "id": 1,
            "brand_id": 1,
            "business_name": "Business Name",
            "phone": "123456789",
            "fax": "123456789",
            "address": "123 Fake St",
            "address2": "",
            "city": "San Francisco",
            "state_name": "",
            "zipcode": "12345",
            "email": "john.doe@example.com",
            "website": "http://example.om",
            "status": "active",
            "category": {
                "id": 52,
                "name": "Other",
                "description": "Other"
            },
            "country": {
                "id": 230,
                "code": "US",
                "country": "United States"
            },
            "state": {
                "id": 5,
                "name": "California",
                "abbr": "CA",
                "description": "California"
            }
        }
    ]
}

post post

Updates a business object.

To update a business object you must supply the uniqe identifier id to business's resouce link /api/v1/businesses/ id

HTTP Request

PUT https://dev.qebot.com/api/v1/businesses/<ID>

PATCH https://dev.qebot.com/api/v1/businesses/<ID>

Param		Description
business_name	string	Name of the business.
brand_id	integer	Unique identifier for the brand of a business. See Brand Object
category_id	integer	Unique identifier for category of a business. See Category Object
phone	string	A phone contact number of the busieness.
fax	string	A fax number for the busieness.
address	string	Address of the business.
address2	string	Extra information for business address.
city	string	City of the business.
state_id	integer	Unique identifier for the state of a business. See State object
state	string	Name of the state where address resides.
country_id	integer	Unique identifier for the country of a business. See Country object
zipcode	string	Zipcode of the business.
email	string	Contact email for the business.
website	string	Website for the business.
status	string	Status of the business. Possible values: (active, inactive)

Returns

Returns an array of a business.

Delete Business

DELETE /api/v1/businesses/ id

Example Request

# Brand id needs to be appended after api uri
curl "https://dev.qebot.com/api/v1/businesses/<ID>"
    -X PATCH
  -u "<USERNAME>:<API_TOKEN>"

Example Response

delete

Deletes a business object.

To delete a business object you must supply the uniqe identifier id to business's resouce link /api/v1/businesses/ id

HTTP Request

DELETE https://dev.qebot.com/api/v1/businesses/<ID>

Returns

Returns an empty response.

Users

The User resource lets you retrieve information associated with a Qebot user, such as a person’s name, role, and status.

User Object

Attribute		Description
id	integer	Internal unique identifier for the object.
parent_id	integer	Unique identifier for the parent of the user object.
first_name	string	First name of the user.
last_name	string	Last name of the user.
username	string	Username, email of the user.
created_date	date	The date of when user was created.
status	string	The status of the user. Possible values: (active, inactive)
role	Role	Role Object.

Role Object

Attribute		Description
id	integer	Internal unique identifier for the object.
name	integer	Name of the role object.

Possible Roles

Roles id 1 name Super Admin id 2 name Corporate Admin id 3 name Business Admin id 4 name User

Retrieve A User List

GET /api/v1/users

Example Request

# With shell, you can just pass the correct header with each request
curl "https://dev.qebot.com/api/v1/users"
  -u "<USERNAME>:<API_TOKEN>"

Example Response

{
    "users": [
        {
            "id": 1,
            "parent_id": 1,
            "first_name": "John",
            "last_name": "Doe",
            "username": "user@example.com",
            "created_date": "2016-10-06T13:28:27+00:00",
            "status": "active",
            "role": {
                "id": 2,
                "name": "Corporate Admin",
            }
        },
        {...}
    ]
}

{
    "users": [
        {
            "id": 1,
            "parent_id": 1,
            "first_name": "John",
            "last_name": "Doe",
            "username": "user@example.com",
            "created_date": "2016-10-06T13:28:27+00:00",
            "status": "active",
            "role": {
                "id": 2,
                "name": "Corporate Admin",
            }
        },
        {...}
    ]
}

{
    "users": [
        {
            "id": 1,
            "parent_id": 1,
            "first_name": "John",
            "last_name": "Doe",
            "username": "user@example.com",
            "created_date": "2016-10-06T13:28:27+00:00",
            "status": "active",
            "role": {
                "id": 2,
                "name": "Corporate Admin",
            }
        },
        {...}
    ]
}

{
    "users": [
        {
            "id": 1,
            "parent_id": 1,
            "first_name": "John",
            "last_name": "Doe",
            "username": "user@example.com",
            "created_date": "2016-10-06T13:28:27+00:00",
            "status": "active",
            "role": {
                "id": 2,
                "name": "Corporate Admin",
            }
        },
        {...}
    ]
}

{
    "users": [
        {
            "id": 1,
            "parent_id": 1,
            "first_name": "John",
            "last_name": "Doe",
            "username": "user@example.com",
            "created_date": "2016-10-06T13:28:27+00:00",
            "status": "active",
            "role": {
                "id": 2,
                "name": "Corporate Admin",
            }
        },
        {...}
    ]
}

{
    "users": [
        {
            "id": 1,
            "parent_id": 1,
            "first_name": "John",
            "last_name": "Doe",
            "username": "user@example.com",
            "created_date": "2016-10-06T13:28:27+00:00",
            "status": "active",
            "role": {
                "id": 2,
                "name": "Corporate Admin",
            }
        },
        {...}
    ]
}

get

Retrieves a list of accessible all users.

HTTP Request

GET https://dev.qebot.com/api/v1/users

Returns

Returns an array of users.

Create User

POST /api/v1/users

Example Request

# With shell, you can just pass the correct header with each request
curl "https://dev.qebot.com/api/v1/users"
  -X POST
  -u "<USERNAME>:<API_TOKEN>"
  -d first_name=John
  -d last_name=Doe
  -d role_id=1
  -d status=active

Example Response

{
    "users": [
        {
            "id": 1,
            "parent_id": 1,
            "first_name": "John",
            "last_name": "Doe",
            "username": "user@example.com",
            "role_id": 4,
            "created_date": "2016-10-06T13:28:27+00:00",
            "ip": "123.45.67.890",
        }
    ]
}

{
    "users": [
        {
            "id": 1,
            "parent_id": 1,
            "first_name": "John",
            "last_name": "Doe",
            "username": "user@example.com",
            "role_id": 4,
            "created_date": "2016-10-06T13:28:27+00:00",
            "ip": "123.45.67.890",
        }
    ]
}

{
    "users": [
        {
            "id": 1,
            "parent_id": 1,
            "first_name": "John",
            "last_name": "Doe",
            "username": "user@example.com",
            "role_id": 4,
            "created_date": "2016-10-06T13:28:27+00:00",
            "ip": "123.45.67.890",
        }
    ]
}

{
    "users": [
        {
            "id": 1,
            "parent_id": 1,
            "first_name": "John",
            "last_name": "Doe",
            "username": "user@example.com",
            "role_id": 4,
            "created_date": "2016-10-06T13:28:27+00:00",
            "ip": "123.45.67.890",
        }
    ]
}

{
    "users": [
        {
            "id": 1,
            "parent_id": 1,
            "first_name": "John",
            "last_name": "Doe",
            "username": "user@example.com",
            "role_id": 4,
            "created_date": "2016-10-06T13:28:27+00:00",
            "ip": "123.45.67.890",
        }
    ]
}

{
    "users": [
        {
            "id": 1,
            "parent_id": 1,
            "first_name": "John",
            "last_name": "Doe",
            "username": "user@example.com",
            "role_id": 4,
            "created_date": "2016-10-06T13:28:27+00:00",
            "ip": "123.45.67.890",
        }
    ]
}

post

Create a user object.

HTTP Request

POST https://dev.qebot.com/api/v1/users

Param		Description
first_name `requried`	string	First name of the user.
last_name `requried`	string	Last name of the user.
username `requried`	string	Username of the user.
password `requried`	string	Password of the user.
role_id `requried`	string	Role of the user. Possible values: (2,3,4). See Role Object
brand_ids	array[`brand_id`]	An array of Brand ids.
business_ids	array[`business_id`]	An array of Business ids.
status	string	Status of the user. Possible values: (active, inactive)

Returns

Returns an array of a user.

Retrieve User

GET /api/v1/users/ id

Example Request

# With shell, you can just pass the correct header with each request
curl "https://dev.qebot.com/api/v1/users/<ID>"
  -u "<USERNAME>:<API_TOKEN>"

Example Response

{
    "users": [
        {
            "id": 1,
            "parent_id": 1,
            "first_name": "John",
            "last_name": "Doe",
            "username": "user@example.com",
            "created_date": "2016-10-06T13:28:27+00:00",
            "status": "active",
            "role": {
                "id": 2,
                "name": "Corporate Admin",
            }
        }
    ]
}

{
    "users": [
        {
            "id": 1,
            "parent_id": 1,
            "first_name": "John",
            "last_name": "Doe",
            "username": "user@example.com",
            "created_date": "2016-10-06T13:28:27+00:00",
            "status": "active",
            "role": {
                "id": 2,
                "name": "Corporate Admin",
            }
        }
    ]
}

{
    "users": [
        {
            "id": 1,
            "parent_id": 1,
            "first_name": "John",
            "last_name": "Doe",
            "username": "user@example.com",
            "created_date": "2016-10-06T13:28:27+00:00",
            "status": "active",
            "role": {
                "id": 2,
                "name": "Corporate Admin",
            }
        }
    ]
}

{
    "users": [
        {
            "id": 1,
            "parent_id": 1,
            "first_name": "John",
            "last_name": "Doe",
            "username": "user@example.com",
            "created_date": "2016-10-06T13:28:27+00:00",
            "status": "active",
            "role": {
                "id": 2,
                "name": "Corporate Admin",
            }
        }
    ]
}

{
    "users": [
        {
            "id": 1,
            "parent_id": 1,
            "first_name": "John",
            "last_name": "Doe",
            "username": "user@example.com",
            "created_date": "2016-10-06T13:28:27+00:00",
            "status": "active",
            "role": {
                "id": 2,
                "name": "Corporate Admin",
            }
        }
    ]
}

{
    "users": [
        {
            "id": 1,
            "parent_id": 1,
            "first_name": "John",
            "last_name": "Doe",
            "username": "user@example.com",
            "created_date": "2016-10-06T13:28:27+00:00",
            "status": "active",
            "role": {
                "id": 2,
                "name": "Corporate Admin",
            }
        }
    ]
}

get

Retrieves a user from a previously created user object.

To retrieve a user object you must supply the uniqe identifier id to user's resouce link /api/v1/users/ id

HTTP Request

GET https://dev.qebot.com/api/v1/users/<ID>

Returns

Returns an array of a user.

Update User

PUT /api/v1/users/ id

PATCH /api/v1/users/ id

Example Request

# User id needs to be appended after api uri
curl "https://dev.qebot.com/api/v1/users/<ID>"
    -X PATCH
  -u "<USERNAME>:<API_TOKEN>"
  -d first_name=John
  -d last_name=Doe
  -d role_id=2

Example Response

{
    "users": [
        {
            "id": 1,
            "parent_id": 1,
            "first_name": "John",
            "last_name": "Doe",
            "username": "user@example.com",
            "created_date": "2016-10-06T13:28:27+00:00",
            "status": "active",
            "role": {
                "id": 2,
                "name": "Corporate Admin",
            }
        }
    ]
}

{
    "users": [
        {
            "id": 1,
            "parent_id": 1,
            "first_name": "John",
            "last_name": "Doe",
            "username": "user@example.com",
            "created_date": "2016-10-06T13:28:27+00:00",
            "status": "active",
            "role": {
                "id": 2,
                "name": "Corporate Admin",
            }
        }
    ]
}

{
    "users": [
        {
            "id": 1,
            "parent_id": 1,
            "first_name": "John",
            "last_name": "Doe",
            "username": "user@example.com",
            "created_date": "2016-10-06T13:28:27+00:00",
            "status": "active",
            "role": {
                "id": 2,
                "name": "Corporate Admin",
            }
        }
    ]
}

{
    "users": [
        {
            "id": 1,
            "parent_id": 1,
            "first_name": "John",
            "last_name": "Doe",
            "username": "user@example.com",
            "created_date": "2016-10-06T13:28:27+00:00",
            "status": "active",
            "role": {
                "id": 2,
                "name": "Corporate Admin",
            }
        }
    ]
}

{
    "users": [
        {
            "id": 1,
            "parent_id": 1,
            "first_name": "John",
            "last_name": "Doe",
            "username": "user@example.com",
            "created_date": "2016-10-06T13:28:27+00:00",
            "status": "active",
            "role": {
                "id": 2,
                "name": "Corporate Admin",
            }
        }
    ]
}

{
    "users": [
        {
            "id": 1,
            "parent_id": 1,
            "first_name": "John",
            "last_name": "Doe",
            "username": "user@example.com",
            "created_date": "2016-10-06T13:28:27+00:00",
            "status": "active",
            "role": {
                "id": 2,
                "name": "Corporate Admin",
            }
        }
    ]
}

post post

Updates a user object.

To update a user object you must supply the uniqe identifier id to user's resouce link /api/v1/users/ id

HTTP Request

PUT https://dev.qebot.com/api/v1/users/<ID>

PATCH https://dev.qebot.com/api/v1/users/<ID>

Param		Description
first_name	string	First name of user.
last_name	string	Last name of user.
username	string	Username of user, valid email address.
password	string	Password of user.
status	string	Status of user. Possible values: (active, inactive)

Returns

Returns an array of a user.

Delete User

DELETE /api/v1/users/ id

Example Request

# User id needs to be appended after api uri
curl "https://dev.qebot.com/api/v1/users/<ID>"
    -X PATCH
  -u "<USERNAME>:<API_TOKEN>"

Example Response

delete

Deletes a user object.

To delete a user object you must supply the uniqe identifier id to user's resouce link /api/v1/users/ id

HTTP Request

DELETE https://dev.qebot.com/api/v1/users/<ID>

Returns

Returns an empty response.

Single Sign On

Single Sign-on (SSO) happens when a user is authenticated by an application and is then signed in to other applications automatically. The authentication is maintained regardless of platform, technology, or domain the user is using.

In the Qebot ecosystem you will first need to obtain a token to authenticate a user. Once that token is obtained you pass it to token param in your query string. From their you will be automatically redirected to the branded dashboard application fully logged in.

-- POST https://dev.qebot.com/api/v1/sso/apikey |--> {"token":"f9be9aac578b"} -- GET https://dev.qebot.com/api/v1/sso?token=f9be9aac578b |--> (Redirects to branded dashboard)

Create API Key

POST /api/v1/sso/apikey

Example Request

# With shell, you can just pass the correct header with each request
curl "https://dev.qebot.com/api/v1/sso/apikey"
  -X POST
  -u "<USERNAME>:<API_TOKEN>"
  -d username=john.doe@example.com

Example Response

{
    "token":"f9be9aac578b"
}

{
    "token":"f9be9aac578b"
}

{
    "token":"f9be9aac578b"
}

{
    "token":"f9be9aac578b"
}

{
    "token":"f9be9aac578b"
}

{
    "token":"f9be9aac578b"
}

post

Retrieve an authenticated token.

HTTP Request

POST https://dev.qebot.com/api/v1/sso/apikey

Param		Description
username `requried`	string	Username of the user you want authenticated.

Returns

On success will redirect authenticated user to branded dashboard

Log In User

GET /api/v1/sso/login?token=<TOKEN>

Example Request

# With shell, you can just pass the correct header with each request
curl "https://dev.qebot.com/api/v1/sso/login?token=f9be9aac578b"

Example Response

(redirects to authenticated dashbaord)

(redirects to authenticated dashbaord)

(redirects to authenticated dashbaord)

(redirects to authenticated dashbaord)

(redirects to authenticated dashbaord)

get

Redirect to Authenticated Dashboard

HTTP Request

GET https://dev.qebot.com/api/v1/sso/login?token=<TOKEN>

Param		Description
token `requried`	string	Token from api key endpoint.

Returns

On success will redirect authenticated user to branded dashboard

Log Out User

GET /api/v1/sso/logout?token=<TOKEN>

Example Request

# With shell, you can just pass the correct header with each request
curl "https://dev.qebot.com/api/v1/sso/logout?token=f9be9aac578b"

Example Response

(redirects to authenticated dashbaord)

(redirects to authenticated dashbaord)

(redirects to authenticated dashbaord)

(redirects to authenticated dashbaord)

(redirects to authenticated dashbaord)

get

Logging Out an Authenticated User

HTTP Request

GET https://dev.qebot.com/api/v1/sso/logout?token=<TOKEN>

Param		Description
token `requried`	string	Token from api key endpoint.

Returns

On success will redirect an un-authenticated user to branded login screen.

Log In User JWT

GET /api/v1/sso/jwt/<EMAIL>?token=<TOKEN>

Example Request

# With shell, you can just pass the correct header with each request
curl "https://dev.qebot.com/api/v1/sso/jwt/jd@e.com?token=f9be9aac578b"

Example Response

(redirects to authenticated dashbaord)

(redirects to authenticated dashbaord)

(redirects to authenticated dashbaord)

(redirects to authenticated dashbaord)

(redirects to authenticated dashbaord)

get

Redirect to Authenticated Dashboard

HTTP Request

GET https://dev.qebot.com/api/v1/sso/jwt/<EMAIL>?token=<TOKEN>

Your JWT payload must have email (username you are attempting to log into), iat (timestamp of request),and exp (timestamp of when token expires)


payload = {

   'email':'john.doe@gmail.com',

   'iat':<CURRENT TIMESTAMP>,

   'exp':<CURRENT TIMESTAMP>+3600

}



JWT::encode(payload, <KEY>)

Param		Description
token `requried`	string	JWT token

Returns

On success will redirect authenticated user to branded dashboard

CRM

The Customer relationship management or CRM contains all things customer management. So lead management and customer storage is your place to go coming here.

Leads

Leads are the mangagement of prospect individuals who can become customers.

CRM Leads Object

Attribute		Description
id	integer	Internal unique identifier for the lead object.
objectId	integer	Internal unique identifier for the object.
leadId	integer	Internal unique identifier for the lead.
firstName	string	First name of the customer lead.
lastName	string	Last name of the customer lead.
fullName	string	Full name of the customer lead.
leadStatus	integer	Identifier for lead status.
leadStatusMeaning	string	Description name for lead status
leadSource	integer	Identifier for lead source.
leadSourceMeaning	string	Description name for lead source.
wayToContact	string	Preferred way to contact.
easyWayToContact	string	Easiest way to contact.
assigneeObjectRefId	integer	Identifier for employee reference assigned to the lead.
assigneeObjectRefName	integer	Full name of employee reference assigned to the lead.
assigneeObjectId	integer	Identifier of employee assigned to the lead.
referredById	string	Identifier or name of person who referred the lead.
description	string	Description.
potentialAmount	decimal	Potential amount to charge customer lead.
objectStatus	integer	Is customer active (0/1).
isActive	decimal	Is customer active (Y/N).
actualAmount	decimal	Actual amount to charge customer lead.
isUnsubscribed	string	Has customer un-subscribed (Y/N)
isBounced	string	Has customer's email bounced (Y/N).
firmId	integer	Identifier of firm.
customAttributes	customAttributes	Custom Attribues Object.
addresses	addresses	Addresses Object.
phoneNumbers	phoneNumbers	Phone Numbers Object.
emailAddresses	emailAddresses	Email Addresses Object.
createdBy	integer	Identifier of who created the lead.
lastUpdatedBy	integer	Identifier of who updated the lead.
createdByName	string	Name of the person who created the lead.
creationDate	date	Creation date of the lead.
lastUpdateDate	date	Last updated date of the lead.
lastUpdatedByName	string	Name of the person who last updated the lead.
createdByObjectId	integer	Identifier of the person who created the lead.
createdByObjectRefId	integer	Identifier of the person reference who created the lead.

Retrieve A Lead List

GET /api/v1/crm/leads

Example Request

# With shell, you can just pass the correct header with each request
curl "https://dev.qebot.com/api/v1/crm/leads"
  -u "<USERNAME>:<API_TOKEN>"

Example Response

{
    "leads":[{
        "id":"3443285",
        "objectId":4,
        "leadId":3443285,
        "firstName":"John",
        "lastName":"Doe",
        "fullName":"John Doe",
        "leadStatus":"1",
        "leadStatusMeaning":"New",
        "leadSource":"1",
        "leadSourceMeaning":"Cold Call",
        "wayToContact":"Email",
        "easyWayToContact":"EMAIL",
        "assigneeObjectRefId":46368,
        "assigneeObjectRefName":"Demo Demo",
        "assigneeObjectId":8,
        "referredById":46368,
        "referredByName":"Demo Demo",
        "description":"",
        "potentialAmount":0,
        "objectStatus":"0",
        "isActive":"Y",
        "actualAmount":0.00,
        "isUnsubscribed":"N",
        "isBounced":"N",
        "notes":[

        ],
        "accounts":[

        ],
        "firmId":229874,
        "customAttributes":[

        ],
        "labels":[

        ],
        "removeLabels":[

        ],
        "addresses":[
            {
                "addressId":14984574,
                "addressAttributeId":"address_section_attr_id",
                "addressType":"Billing Address",
                "addressTypeCode":"1",
                "addressLine1":"123 Krypton Dr",
                "addressLine2":"",
                "city":"Smallville",
                "county":"",
                "state":"Kansas",
                "stateCode":"KS",
                "countryId":176,
                "countryName":"United States",
                "countryCode":"US",
                "zipCode":"67524",
                "addressGroupName":"Address1"
            }
        ],
        "removeAddresses":[

        ],
        "phoneNumbers":[

        ],
        "removePhoneNumbers":[

        ],
        "emailAddresses":[

        ],
        "removeEmailAddresses":[

        ],
        "metaAttributeMap":{

        },
        "metaObjectMap":{

        },
        "createdBy":49683,
        "lastUpdatedBy":49683,
        "createdByName":"Demo Demo",
        "creationDate":"Sep 02, 2020 04:01:23 PM",
        "lastUpdateDate":"Sep 02, 2020 04:01:23 PM",
        "lastUpdatedByName":"Demo Demo",
        "version":1,
        "createdByObjectId":8,
        "createdByObjectRefId":46368,
        "toObjectIds":[

        ]
    },
    {...}
]}

{
    "leads":[{
        "id":"3443285",
        "objectId":4,
        "leadId":3443285,
        "firstName":"John",
        "lastName":"Doe",
        "fullName":"John Doe",
        "leadStatus":"1",
        "leadStatusMeaning":"New",
        "leadSource":"1",
        "leadSourceMeaning":"Cold Call",
        "wayToContact":"Email",
        "easyWayToContact":"EMAIL",
        "assigneeObjectRefId":46368,
        "assigneeObjectRefName":"Demo Demo",
        "assigneeObjectId":8,
        "referredById":46368,
        "referredByName":"Demo Demo",
        "description":"",
        "potentialAmount":0,
        "objectStatus":"0",
        "isActive":"Y",
        "actualAmount":0.00,
        "isUnsubscribed":"N",
        "isBounced":"N",
        "notes":[

        ],
        "accounts":[

        ],
        "firmId":229874,
        "customAttributes":[

        ],
        "labels":[

        ],
        "removeLabels":[

        ],
        "addresses":[
            {
                "addressId":14984574,
                "addressAttributeId":"address_section_attr_id",
                "addressType":"Billing Address",
                "addressTypeCode":"1",
                "addressLine1":"123 Krypton Dr",
                "addressLine2":"",
                "city":"Smallville",
                "county":"",
                "state":"Kansas",
                "stateCode":"KS",
                "countryId":176,
                "countryName":"United States",
                "countryCode":"US",
                "zipCode":"67524",
                "addressGroupName":"Address1"
            }
        ],
        "removeAddresses":[

        ],
        "phoneNumbers":[

        ],
        "removePhoneNumbers":[

        ],
        "emailAddresses":[

        ],
        "removeEmailAddresses":[

        ],
        "metaAttributeMap":{

        },
        "metaObjectMap":{

        },
        "createdBy":49683,
        "lastUpdatedBy":49683,
        "createdByName":"Demo Demo",
        "creationDate":"Sep 02, 2020 04:01:23 PM",
        "lastUpdateDate":"Sep 02, 2020 04:01:23 PM",
        "lastUpdatedByName":"Demo Demo",
        "version":1,
        "createdByObjectId":8,
        "createdByObjectRefId":46368,
        "toObjectIds":[

        ]
    },
    {...}
]}

{
    "leads":[{
        "id":"3443285",
        "objectId":4,
        "leadId":3443285,
        "firstName":"John",
        "lastName":"Doe",
        "fullName":"John Doe",
        "leadStatus":"1",
        "leadStatusMeaning":"New",
        "leadSource":"1",
        "leadSourceMeaning":"Cold Call",
        "wayToContact":"Email",
        "easyWayToContact":"EMAIL",
        "assigneeObjectRefId":46368,
        "assigneeObjectRefName":"Demo Demo",
        "assigneeObjectId":8,
        "referredById":46368,
        "referredByName":"Demo Demo",
        "description":"",
        "potentialAmount":0,
        "objectStatus":"0",
        "isActive":"Y",
        "actualAmount":0.00,
        "isUnsubscribed":"N",
        "isBounced":"N",
        "notes":[

        ],
        "accounts":[

        ],
        "firmId":229874,
        "customAttributes":[

        ],
        "labels":[

        ],
        "removeLabels":[

        ],
        "addresses":[
            {
                "addressId":14984574,
                "addressAttributeId":"address_section_attr_id",
                "addressType":"Billing Address",
                "addressTypeCode":"1",
                "addressLine1":"123 Krypton Dr",
                "addressLine2":"",
                "city":"Smallville",
                "county":"",
                "state":"Kansas",
                "stateCode":"KS",
                "countryId":176,
                "countryName":"United States",
                "countryCode":"US",
                "zipCode":"67524",
                "addressGroupName":"Address1"
            }
        ],
        "removeAddresses":[

        ],
        "phoneNumbers":[

        ],
        "removePhoneNumbers":[

        ],
        "emailAddresses":[

        ],
        "removeEmailAddresses":[

        ],
        "metaAttributeMap":{

        },
        "metaObjectMap":{

        },
        "createdBy":49683,
        "lastUpdatedBy":49683,
        "createdByName":"Demo Demo",
        "creationDate":"Sep 02, 2020 04:01:23 PM",
        "lastUpdateDate":"Sep 02, 2020 04:01:23 PM",
        "lastUpdatedByName":"Demo Demo",
        "version":1,
        "createdByObjectId":8,
        "createdByObjectRefId":46368,
        "toObjectIds":[

        ]
    },
    {...}
]}

{
    "leads":[{
        "id":"3443285",
        "objectId":4,
        "leadId":3443285,
        "firstName":"John",
        "lastName":"Doe",
        "fullName":"John Doe",
        "leadStatus":"1",
        "leadStatusMeaning":"New",
        "leadSource":"1",
        "leadSourceMeaning":"Cold Call",
        "wayToContact":"Email",
        "easyWayToContact":"EMAIL",
        "assigneeObjectRefId":46368,
        "assigneeObjectRefName":"Demo Demo",
        "assigneeObjectId":8,
        "referredById":46368,
        "referredByName":"Demo Demo",
        "description":"",
        "potentialAmount":0,
        "objectStatus":"0",
        "isActive":"Y",
        "actualAmount":0.00,
        "isUnsubscribed":"N",
        "isBounced":"N",
        "notes":[

        ],
        "accounts":[

        ],
        "firmId":229874,
        "customAttributes":[

        ],
        "labels":[

        ],
        "removeLabels":[

        ],
        "addresses":[
            {
                "addressId":14984574,
                "addressAttributeId":"address_section_attr_id",
                "addressType":"Billing Address",
                "addressTypeCode":"1",
                "addressLine1":"123 Krypton Dr",
                "addressLine2":"",
                "city":"Smallville",
                "county":"",
                "state":"Kansas",
                "stateCode":"KS",
                "countryId":176,
                "countryName":"United States",
                "countryCode":"US",
                "zipCode":"67524",
                "addressGroupName":"Address1"
            }
        ],
        "removeAddresses":[

        ],
        "phoneNumbers":[

        ],
        "removePhoneNumbers":[

        ],
        "emailAddresses":[

        ],
        "removeEmailAddresses":[

        ],
        "metaAttributeMap":{

        },
        "metaObjectMap":{

        },
        "createdBy":49683,
        "lastUpdatedBy":49683,
        "createdByName":"Demo Demo",
        "creationDate":"Sep 02, 2020 04:01:23 PM",
        "lastUpdateDate":"Sep 02, 2020 04:01:23 PM",
        "lastUpdatedByName":"Demo Demo",
        "version":1,
        "createdByObjectId":8,
        "createdByObjectRefId":46368,
        "toObjectIds":[

        ]
    },
    {...}
]}

{
    "leads":[{
        "id":"3443285",
        "objectId":4,
        "leadId":3443285,
        "firstName":"John",
        "lastName":"Doe",
        "fullName":"John Doe",
        "leadStatus":"1",
        "leadStatusMeaning":"New",
        "leadSource":"1",
        "leadSourceMeaning":"Cold Call",
        "wayToContact":"Email",
        "easyWayToContact":"EMAIL",
        "assigneeObjectRefId":46368,
        "assigneeObjectRefName":"Demo Demo",
        "assigneeObjectId":8,
        "referredById":46368,
        "referredByName":"Demo Demo",
        "description":"",
        "potentialAmount":0,
        "objectStatus":"0",
        "isActive":"Y",
        "actualAmount":0.00,
        "isUnsubscribed":"N",
        "isBounced":"N",
        "notes":[

        ],
        "accounts":[

        ],
        "firmId":229874,
        "customAttributes":[

        ],
        "labels":[

        ],
        "removeLabels":[

        ],
        "addresses":[
            {
                "addressId":14984574,
                "addressAttributeId":"address_section_attr_id",
                "addressType":"Billing Address",
                "addressTypeCode":"1",
                "addressLine1":"123 Krypton Dr",
                "addressLine2":"",
                "city":"Smallville",
                "county":"",
                "state":"Kansas",
                "stateCode":"KS",
                "countryId":176,
                "countryName":"United States",
                "countryCode":"US",
                "zipCode":"67524",
                "addressGroupName":"Address1"
            }
        ],
        "removeAddresses":[

        ],
        "phoneNumbers":[

        ],
        "removePhoneNumbers":[

        ],
        "emailAddresses":[

        ],
        "removeEmailAddresses":[

        ],
        "metaAttributeMap":{

        },
        "metaObjectMap":{

        },
        "createdBy":49683,
        "lastUpdatedBy":49683,
        "createdByName":"Demo Demo",
        "creationDate":"Sep 02, 2020 04:01:23 PM",
        "lastUpdateDate":"Sep 02, 2020 04:01:23 PM",
        "lastUpdatedByName":"Demo Demo",
        "version":1,
        "createdByObjectId":8,
        "createdByObjectRefId":46368,
        "toObjectIds":[

        ]
    },
    {...}
]}

{
    "leads":[{
        "id":"3443285",
        "objectId":4,
        "leadId":3443285,
        "firstName":"John",
        "lastName":"Doe",
        "fullName":"John Doe",
        "leadStatus":"1",
        "leadStatusMeaning":"New",
        "leadSource":"1",
        "leadSourceMeaning":"Cold Call",
        "wayToContact":"Email",
        "easyWayToContact":"EMAIL",
        "assigneeObjectRefId":46368,
        "assigneeObjectRefName":"Demo Demo",
        "assigneeObjectId":8,
        "referredById":46368,
        "referredByName":"Demo Demo",
        "description":"",
        "potentialAmount":0,
        "objectStatus":"0",
        "isActive":"Y",
        "actualAmount":0.00,
        "isUnsubscribed":"N",
        "isBounced":"N",
        "notes":[

        ],
        "accounts":[

        ],
        "firmId":229874,
        "customAttributes":[

        ],
        "labels":[

        ],
        "removeLabels":[

        ],
        "addresses":[
            {
                "addressId":14984574,
                "addressAttributeId":"address_section_attr_id",
                "addressType":"Billing Address",
                "addressTypeCode":"1",
                "addressLine1":"123 Krypton Dr",
                "addressLine2":"",
                "city":"Smallville",
                "county":"",
                "state":"Kansas",
                "stateCode":"KS",
                "countryId":176,
                "countryName":"United States",
                "countryCode":"US",
                "zipCode":"67524",
                "addressGroupName":"Address1"
            }
        ],
        "removeAddresses":[

        ],
        "phoneNumbers":[

        ],
        "removePhoneNumbers":[

        ],
        "emailAddresses":[

        ],
        "removeEmailAddresses":[

        ],
        "metaAttributeMap":{

        },
        "metaObjectMap":{

        },
        "createdBy":49683,
        "lastUpdatedBy":49683,
        "createdByName":"Demo Demo",
        "creationDate":"Sep 02, 2020 04:01:23 PM",
        "lastUpdateDate":"Sep 02, 2020 04:01:23 PM",
        "lastUpdatedByName":"Demo Demo",
        "version":1,
        "createdByObjectId":8,
        "createdByObjectRefId":46368,
        "toObjectIds":[

        ]
    },
    {...}
]}

get

Retrieves a list of leads.

HTTP Request

GET https://dev.qebot.com/api/v1/crm/leads

Returns

Returns an array of leads.

Create Lead

POST /api/v1/crm/leads

Example Request

# With shell, you can just pass the correct header with each request curl "https://dev.qebot.com/api/v1/crm/leads" -X POST -u "<USERNAME>:<API_TOKEN>" -d firstName=John -d lastName=Doe -d emailAddress=john.doe@example.com -d phoneNumbers[0][phoneNumber]=5558675309 -d phoneNumbers[0][phoneType]=Business -d phoneNumbers[0][phoneTypeCode]=PHONE_BUSINESS -d companyName="Detective Comics"

Example Response

{ "leads":[{ "id":"3443285", "objectId":4, "leadId":3443285, "firstName":"John", "lastName":"Doe", "fullName":"John Doe", "leadStatus":"1", "leadStatusMeaning":"New", "leadSource":"1", "leadSourceMeaning":"Cold Call", "wayToContact":"Email", "easyWayToContact":"EMAIL", "assigneeObjectRefId":46368, "assigneeObjectRefName":"Demo Demo", "assigneeObjectId":8, "referredById":46368, "referredByName":"Demo Demo", "description":"", "potentialAmount":0, "objectStatus":"0", "isActive":"Y", "actualAmount":0.00, "isUnsubscribed":"N", "isBounced":"N", "notes":[ ], "accounts":[ ], "firmId":229874, "customAttributes":[ ], "labels":[ ], "removeLabels":[ ], "addresses":[ { "addressId":14984574, "addressAttributeId":"address_section_attr_id", "addressType":"Billing Address", "addressTypeCode":"1", "addressLine1":"123 Krypton Dr", "addressLine2":"", "city":"Smallville", "county":"", "state":"Kansas", "stateCode":"KS", "countryId":176, "countryName":"United States", "countryCode":"US", "zipCode":"67524", "addressGroupName":"Address1" } ], "removeAddresses":[ ], "phoneNumbers":[ ], "removePhoneNumbers":[ ], "emailAddresses":[ ], "removeEmailAddresses":[ ], "metaAttributeMap":{ }, "metaObjectMap":{ }, "createdBy":49683, "lastUpdatedBy":49683, "createdByName":"Demo Demo", "creationDate":"Sep 02, 2020 04:01:23 PM", "lastUpdateDate":"Sep 02, 2020 04:01:23 PM", "lastUpdatedByName":"Demo Demo", "version":1, "createdByObjectId":8, "createdByObjectRefId":46368, "toObjectIds":[ ] }, {...} ]}
{ "leads":[{ "id":"3443285", "objectId":4, "leadId":3443285, "firstName":"John", "lastName":"Doe", "fullName":"John Doe", "leadStatus":"1", "leadStatusMeaning":"New", "leadSource":"1", "leadSourceMeaning":"Cold Call", "wayToContact":"Email", "easyWayToContact":"EMAIL", "assigneeObjectRefId":46368, "assigneeObjectRefName":"Demo Demo", "assigneeObjectId":8, "referredById":46368, "referredByName":"Demo Demo", "description":"", "potentialAmount":0, "objectStatus":"0", "isActive":"Y", "actualAmount":0.00, "isUnsubscribed":"N", "isBounced":"N", "notes":[ ], "accounts":[ ], "firmId":229874, "customAttributes":[ ], "labels":[ ], "removeLabels":[ ], "addresses":[ { "addressId":14984574, "addressAttributeId":"address_section_attr_id", "addressType":"Billing Address", "addressTypeCode":"1", "addressLine1":"123 Krypton Dr", "addressLine2":"", "city":"Smallville", "county":"", "state":"Kansas", "stateCode":"KS", "countryId":176, "countryName":"United States", "countryCode":"US", "zipCode":"67524", "addressGroupName":"Address1" } ], "removeAddresses":[ ], "phoneNumbers":[ ], "removePhoneNumbers":[ ], "emailAddresses":[ ], "removeEmailAddresses":[ ], "metaAttributeMap":{ }, "metaObjectMap":{ }, "createdBy":49683, "lastUpdatedBy":49683, "createdByName":"Demo Demo", "creationDate":"Sep 02, 2020 04:01:23 PM", "lastUpdateDate":"Sep 02, 2020 04:01:23 PM", "lastUpdatedByName":"Demo Demo", "version":1, "createdByObjectId":8, "createdByObjectRefId":46368, "toObjectIds":[ ] }, {...} ]}
{ "leads":[{ "id":"3443285", "objectId":4, "leadId":3443285, "firstName":"John", "lastName":"Doe", "fullName":"John Doe", "leadStatus":"1", "leadStatusMeaning":"New", "leadSource":"1", "leadSourceMeaning":"Cold Call", "wayToContact":"Email", "easyWayToContact":"EMAIL", "assigneeObjectRefId":46368, "assigneeObjectRefName":"Demo Demo", "assigneeObjectId":8, "referredById":46368, "referredByName":"Demo Demo", "description":"", "potentialAmount":0, "objectStatus":"0", "isActive":"Y", "actualAmount":0.00, "isUnsubscribed":"N", "isBounced":"N", "notes":[ ], "accounts":[ ], "firmId":229874, "customAttributes":[ ], "labels":[ ], "removeLabels":[ ], "addresses":[ { "addressId":14984574, "addressAttributeId":"address_section_attr_id", "addressType":"Billing Address", "addressTypeCode":"1", "addressLine1":"123 Krypton Dr", "addressLine2":"", "city":"Smallville", "county":"", "state":"Kansas", "stateCode":"KS", "countryId":176, "countryName":"United States", "countryCode":"US", "zipCode":"67524", "addressGroupName":"Address1" } ], "removeAddresses":[ ], "phoneNumbers":[ ], "removePhoneNumbers":[ ], "emailAddresses":[ ], "removeEmailAddresses":[ ], "metaAttributeMap":{ }, "metaObjectMap":{ }, "createdBy":49683, "lastUpdatedBy":49683, "createdByName":"Demo Demo", "creationDate":"Sep 02, 2020 04:01:23 PM", "lastUpdateDate":"Sep 02, 2020 04:01:23 PM", "lastUpdatedByName":"Demo Demo", "version":1, "createdByObjectId":8, "createdByObjectRefId":46368, "toObjectIds":[ ] }, {...} ]}
{ "leads":[{ "id":"3443285", "objectId":4, "leadId":3443285, "firstName":"John", "lastName":"Doe", "fullName":"John Doe", "leadStatus":"1", "leadStatusMeaning":"New", "leadSource":"1", "leadSourceMeaning":"Cold Call", "wayToContact":"Email", "easyWayToContact":"EMAIL", "assigneeObjectRefId":46368, "assigneeObjectRefName":"Demo Demo", "assigneeObjectId":8, "referredById":46368, "referredByName":"Demo Demo", "description":"", "potentialAmount":0, "objectStatus":"0", "isActive":"Y", "actualAmount":0.00, "isUnsubscribed":"N", "isBounced":"N", "notes":[ ], "accounts":[ ], "firmId":229874, "customAttributes":[ ], "labels":[ ], "removeLabels":[ ], "addresses":[ { "addressId":14984574, "addressAttributeId":"address_section_attr_id", "addressType":"Billing Address", "addressTypeCode":"1", "addressLine1":"123 Krypton Dr", "addressLine2":"", "city":"Smallville", "county":"", "state":"Kansas", "stateCode":"KS", "countryId":176, "countryName":"United States", "countryCode":"US", "zipCode":"67524", "addressGroupName":"Address1" } ], "removeAddresses":[ ], "phoneNumbers":[ ], "removePhoneNumbers":[ ], "emailAddresses":[ ], "removeEmailAddresses":[ ], "metaAttributeMap":{ }, "metaObjectMap":{ }, "createdBy":49683, "lastUpdatedBy":49683, "createdByName":"Demo Demo", "creationDate":"Sep 02, 2020 04:01:23 PM", "lastUpdateDate":"Sep 02, 2020 04:01:23 PM", "lastUpdatedByName":"Demo Demo", "version":1, "createdByObjectId":8, "createdByObjectRefId":46368, "toObjectIds":[ ] }, {...} ]}
{ "leads":[{ "id":"3443285", "objectId":4, "leadId":3443285, "firstName":"John", "lastName":"Doe", "fullName":"John Doe", "leadStatus":"1", "leadStatusMeaning":"New", "leadSource":"1", "leadSourceMeaning":"Cold Call", "wayToContact":"Email", "easyWayToContact":"EMAIL", "assigneeObjectRefId":46368, "assigneeObjectRefName":"Demo Demo", "assigneeObjectId":8, "referredById":46368, "referredByName":"Demo Demo", "description":"", "potentialAmount":0, "objectStatus":"0", "isActive":"Y", "actualAmount":0.00, "isUnsubscribed":"N", "isBounced":"N", "notes":[ ], "accounts":[ ], "firmId":229874, "customAttributes":[ ], "labels":[ ], "removeLabels":[ ], "addresses":[ { "addressId":14984574, "addressAttributeId":"address_section_attr_id", "addressType":"Billing Address", "addressTypeCode":"1", "addressLine1":"123 Krypton Dr", "addressLine2":"", "city":"Smallville", "county":"", "state":"Kansas", "stateCode":"KS", "countryId":176, "countryName":"United States", "countryCode":"US", "zipCode":"67524", "addressGroupName":"Address1" } ], "removeAddresses":[ ], "phoneNumbers":[ ], "removePhoneNumbers":[ ], "emailAddresses":[ ], "removeEmailAddresses":[ ], "metaAttributeMap":{ }, "metaObjectMap":{ }, "createdBy":49683, "lastUpdatedBy":49683, "createdByName":"Demo Demo", "creationDate":"Sep 02, 2020 04:01:23 PM", "lastUpdateDate":"Sep 02, 2020 04:01:23 PM", "lastUpdatedByName":"Demo Demo", "version":1, "createdByObjectId":8, "createdByObjectRefId":46368, "toObjectIds":[ ] }, {...} ]}
{ "leads":[{ "id":"3443285", "objectId":4, "leadId":3443285, "firstName":"John", "lastName":"Doe", "fullName":"John Doe", "leadStatus":"1", "leadStatusMeaning":"New", "leadSource":"1", "leadSourceMeaning":"Cold Call", "wayToContact":"Email", "easyWayToContact":"EMAIL", "assigneeObjectRefId":46368, "assigneeObjectRefName":"Demo Demo", "assigneeObjectId":8, "referredById":46368, "referredByName":"Demo Demo", "description":"", "potentialAmount":0, "objectStatus":"0", "isActive":"Y", "actualAmount":0.00, "isUnsubscribed":"N", "isBounced":"N", "notes":[ ], "accounts":[ ], "firmId":229874, "customAttributes":[ ], "labels":[ ], "removeLabels":[ ], "addresses":[ { "addressId":14984574, "addressAttributeId":"address_section_attr_id", "addressType":"Billing Address", "addressTypeCode":"1", "addressLine1":"123 Krypton Dr", "addressLine2":"", "city":"Smallville", "county":"", "state":"Kansas", "stateCode":"KS", "countryId":176, "countryName":"United States", "countryCode":"US", "zipCode":"67524", "addressGroupName":"Address1" } ], "removeAddresses":[ ], "phoneNumbers":[ ], "removePhoneNumbers":[ ], "emailAddresses":[ ], "removeEmailAddresses":[ ], "metaAttributeMap":{ }, "metaObjectMap":{ }, "createdBy":49683, "lastUpdatedBy":49683, "createdByName":"Demo Demo", "creationDate":"Sep 02, 2020 04:01:23 PM", "lastUpdateDate":"Sep 02, 2020 04:01:23 PM", "lastUpdatedByName":"Demo Demo", "version":1, "createdByObjectId":8, "createdByObjectRefId":46368, "toObjectIds":[ ] }, {...} ]}

post

Create a lead object.

HTTP Request

POST https://dev.qebot.com/api/v1/crm/leads

Username should be a valide email address.

The possible values for role_id can decrease based on role of authorized entity. (e.g. a lower level role can not create a user with a higher role than itself)

Request Arguments

Param Description

firstName string First name of the customer.

lastName string Last name of the customer.

jobTitle string Job Title of the customer.

waytoContact string Way to contact customer.

leadStatus integer Lead Status look up code.

leadStatusMeaning string Lead Status text.

leadSource integer Lead Source code.

leadSourceMeaning string Lead Source name.

leadTypeId integer Lead type identifier.

leadTypeName string Lead type name.

referredById integer Identifier of person who referred the customer

referredByName string Name of the person who referred the customer

assigneeObjectRefId integer Identifier of the person who is assigned this customer

assigneeObjectRefName string Name of the person who is assigned this customer reference

Description string Name of the person who is assigned this customer reference

Labels labels Labels object.

skypeName string Name of customer's skype handle.

isUnsubscribed string Is customer unsubscribed.
Possible values: (Y, N).

potentialAmount decimal Possible amount to charge customer.

estimatedCloseDate date Estimated close date from customer.

leadRank string Rank of the lead.

leadRankMeaning string The test of lead ranking.

campaignId integer Identifier of campaign.

campaignName string Name of campaign.

territoryId integer Identifier of territory.

territoryName string Name of territory.

marketId integer Identifier of market.

marketName string Name of market.

segmentId integer Identifier of segment.

segmentName string Name of segment.

accountId integer Identifier of account.

accountName string Name of account.

companyName string Name of account.

employeeRangeId integer Identifier of employee range.

employeeRange string Name of employee range.

annualRevenue string Name of annual revenue.

industry string Name of annual industry.

industryName string Name of annual industry.

ownership string The name of who owns the customer lead.

website string The website URL

faceBookURL string Your facebook website URL

linkedInURL string Your linkedin website URL

twitterURL string Your twitter website URL

phoneNumbers phoneNumbers Phone Numbers object.

emailAddresses emailAddresses Email Addresses object.

addresses addresses Addresses object.

customAttributes customAttributes Custom Attributes object.

Returns

Returns an array of a leads.

file:///Users/corneliuslamb/Sites/slate/build/index.html#create-lead# Tools

The tools are the life blood of the Qebot ecosystem. This resource will show what tools you have at your disposal to purchase from our system.

Tool Object

Attribute Description

id integer Internal unique identifier for the object.

tool string The name of the tool

plan_code string The code used for purchasing a tool.

amount decimal The amount the tool costs.

Retrieve A Tool List

GET /api/v1/tools

Example Request

# With shell, you can just pass the correct header with each request curl "https://dev.qebot.com/api/v1/tools" -u "<USERNAME>:<API_TOKEN>"

Example Response

{ "tools": [ { "id": 1, "tool": "Qebot Tool", "plan_code": "qebot_tool", "amount": 20 }, {...} ] }
{ "tools": [ { "id": 1, "tool": "Qebot Tool", "plan_code": "qebot_tool", "amount": 20 }, {...} ] }
{ "tools": [ { "id": 1, "tool": "Qebot Tool", "plan_code": "qebot_tool", "amount": 20 }, {...} ] }
{ "tools": [ { "id": 1, "tool": "Qebot Tool", "plan_code": "qebot_tool", "amount": 20 }, {...} ] }
{ "tools": [ { "id": 1, "tool": "Qebot Tool", "plan_code": "qebot_tool", "amount": 20 }, {...} ] }
{ "tools": [ { "id": 1, "tool": "Qebot Tool", "plan_code": "qebot_tool", "amount": 20 }, {...} ] }

get

Retrieves a list of accessible tools.

HTTP Request

GET https://dev.qebot.com/api/v1/tools

Returns

Returns an array of tools.

Retrieve Tool

GET /api/v1/tools/ id

Example Request

# With shell, you can just pass the correct header with each request curl "https://dev.qebot.com/api/v1/tools/<ID>" -u "<USERNAME>:<API_TOKEN>"

Example Response

{ "tools": [ { "id": 1, "tool": "Qebot Tool", "plan_code": "qebot_tool", "amount": 20 } ] }
{ "tools": [ { "id": 1, "tool": "Qebot Tool", "plan_code": "qebot_tool", "amount": 20 } ] }
{ "tools": [ { "id": 1, "tool": "Qebot Tool", "plan_code": "qebot_tool", "amount": 20 } ] }
{ "tools": [ { "id": 1, "tool": "Qebot Tool", "plan_code": "qebot_tool", "amount": 20 } ] }
{ "tools": [ { "id": 1, "tool": "Qebot Tool", "plan_code": "qebot_tool", "amount": 20 } ] }
{ "tools": [ { "id": 1, "tool": "Qebot Tool", "plan_code": "qebot_tool", "amount": 20 } ] }

get

Retrieves a tool from a previously created tool object.

To retrieve a tool object you must supply the uniqe identifier id to tool's resouce link /api/v1/tools/ id

HTTP Request

GET https://dev.qebot.com/api/v1/tools/<ID>

Returns

Returns an array of a tool.

Billings

The Billings resource is responsible for creating billing information for purchases. Currently we support billing information for credit card purchases. This resource is also responsible for storing cards on file to ease the redundancy of re-entering business information for each purchase.

Billing Object

Attribute Description

id integer Internal unique identifier for the object.

first_name string First name of the user on billing info.

last_name string Last name of the user on billing info.

company string Name of company on billing info.

address string Address line 1 on billing info.

address2 string Address lin2 on billing info.

city string City of billing on file.

state string State of billing on file.

zip string Zip or postal of billing on file.

country string Country, 2-letter ISO code of billing on file.

card_type string Type of card on billing info. Possible values:
(Visa, MasterCard, American Express, Discover,
JCB, etc)

zip string Zip or postal of billing on file.

expiry_month integer Expiration month of billing card on file.

expiry_year integer Expiration year of billing card on file.

first_six integer First six digits of billing card on file.

last_four integer Last four digits of billing card on file.

vat_number string Customer's VAT number.

ip_address string Customer's IPv4 address when updating their
billing information STRONGLY RECOMMENDED

ip_address_country string 2-letter Country of IP Address of billing info.

Retrieve A Billings List

GET /api/v1/billings

Example Request

# With shell, you can just pass the correct header with each request curl "https://dev.qebot.com/api/v1/billings" -u "<USERNAME>:<API_TOKEN>"

Example Response

{ "billings": [ { "id": 1, "first_name": "John", "last_name": "Doe", "company": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state": "CA", "zip": "12345", "country": "US", "card_type": "Visa", "expiry_year": 2020, "expiry_month": 12, "first_six": "123456", "last_four": "1234", "vat_number": null, "ip_address": null, "ip_address_country": null }, {...} ] }
{ "billings": [ { "id": 1, "first_name": "John", "last_name": "Doe", "company": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state": "CA", "zip": "12345", "country": "US", "card_type": "Visa", "expiry_year": 2020, "expiry_month": 12, "first_six": "123456", "last_four": "1234", "vat_number": null, "ip_address": null, "ip_address_country": null }, {...} ] }
{ "billings": [ { "id": 1, "first_name": "John", "last_name": "Doe", "company": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state": "CA", "zip": "12345", "country": "US", "card_type": "Visa", "expiry_year": 2020, "expiry_month": 12, "first_six": "123456", "last_four": "1234", "vat_number": null, "ip_address": null, "ip_address_country": null }, {...} ] }
{ "billings": [ { "id": 1, "first_name": "John", "last_name": "Doe", "company": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state": "CA", "zip": "12345", "country": "US", "card_type": "Visa", "expiry_year": 2020, "expiry_month": 12, "first_six": "123456", "last_four": "1234", "vat_number": null, "ip_address": null, "ip_address_country": null }, {...} ] }
{ "billings": [ { "id": 1, "first_name": "John", "last_name": "Doe", "company": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state": "CA", "zip": "12345", "country": "US", "card_type": "Visa", "expiry_year": 2020, "expiry_month": 12, "first_six": "123456", "last_four": "1234", "vat_number": null, "ip_address": null, "ip_address_country": null }, {...} ] }
{ "billings": [ { "id": 1, "first_name": "John", "last_name": "Doe", "company": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state": "CA", "zip": "12345", "country": "US", "card_type": "Visa", "expiry_year": 2020, "expiry_month": 12, "first_six": "123456", "last_four": "1234", "vat_number": null, "ip_address": null, "ip_address_country": null }, {...} ] }

get

Retrieves a list of billing info.

HTTP Request

GET https://dev.qebot.com/api/v1/billings

Returns

Returns an array of billing info.

Create Billings

POST /api/v1/billings

Example Request

# With shell, you can just pass the correct header with each request curl "https://dev.qebot.com/api/v1/billings" -X POST -u "<USERNAME>:<API_TOKEN>" -d number=123456789012 -d address1="123 fake st" -d address2="Suite 2" -d city="San Francisco" -d state=CA

Example Response

{ "billings": [ { "id": 1, "first_name": "John", "last_name": "Doe", "company": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state": "CA", "zip": "12345", "country": "US", "card_type": "Visa", "expiry_year": 2020, "expiry_month": 12, "first_six": "123456", "last_four": "1234", "vat_number": null, "ip_address": null, "ip_address_country": null } ] }
{ "billings": [ { "id": 1, "first_name": "John", "last_name": "Doe", "company": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state": "CA", "zip": "12345", "country": "US", "card_type": "Visa", "expiry_year": 2020, "expiry_month": 12, "first_six": "123456", "last_four": "1234", "vat_number": null, "ip_address": null, "ip_address_country": null } ] }
{ "billings": [ { "id": 1, "first_name": "John", "last_name": "Doe", "company": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state": "CA", "zip": "12345", "country": "US", "card_type": "Visa", "expiry_year": 2020, "expiry_month": 12, "first_six": "123456", "last_four": "1234", "vat_number": null, "ip_address": null, "ip_address_country": null } ] }
{ "billings": [ { "id": 1, "first_name": "John", "last_name": "Doe", "company": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state": "CA", "zip": "12345", "country": "US", "card_type": "Visa", "expiry_year": 2020, "expiry_month": 12, "first_six": "123456", "last_four": "1234", "vat_number": null, "ip_address": null, "ip_address_country": null } ] }
{ "billings": [ { "id": 1, "first_name": "John", "last_name": "Doe", "company": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state": "CA", "zip": "12345", "country": "US", "card_type": "Visa", "expiry_year": 2020, "expiry_month": 12, "first_six": "123456", "last_four": "1234", "vat_number": null, "ip_address": null, "ip_address_country": null } ] }
{ "billings": [ { "id": 1, "first_name": "John", "last_name": "Doe", "company": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state": "CA", "zip": "12345", "country": "US", "card_type": "Visa", "expiry_year": 2020, "expiry_month": 12, "first_six": "123456", "last_four": "1234", "vat_number": null, "ip_address": null, "ip_address_country": null } ] }

post

Create a billing object.

HTTP Request

POST https://dev.qebot.com/api/v1/billings

Request Arguments

Param Description

first_name stringrequired First name of the user on billing info.

last_name stringrequired Last name of the user on billing info.

card_number stringrequired Credit card number, spaces and dashes are accepted.

company string Name of company on billing info.

address string Address line 1 on billing info.

address2 string Address lin2 on billing info.

city string City of billing on file.

state string State of billing on file.

zip string Zip or postal of billing on file.

country string Country, 2-letter ISO code of billing on file.

card_type string Type of card on billing info. Possible values: (Visa, MasterCard, American Express, Discover, JCB, etc)

zip string Zip or postal of billing on file.

phone string Phone number, this field can be 10 digits.

expiry_month integerrequired Expiration month of billing card on file.

expiry_year integerrequired Expiration year of billing card on file.

first_six integer First six digits of billing card on file.

last_four integer Last four digits of billing card on file.

vat_number string Customer's VAT number.

currency string Currency in which invoices will be posted. Only applicable if this account is enrolled in a plan has a different currency than your site's default.

cvv string Security code or CVV, 3-4 digits STRONGLY RECOMMENDED.

ip_address string Customer's IPv4 address when updating their billing information STRONGLY RECOMMENDED

Returns

Returns an array of a billing info.

Retrieve Billing

GET /api/v1/billings/ id

Example Request

# With shell, you can just pass the correct header with each request curl "https://dev.qebot.com/api/v1/billings/<ID>" -u "<USERNAME>:<API_TOKEN>"

Example Response

{ "billings": [ { "id": 1, "first_name": "John", "last_name": "Doe", "company": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state": "CA", "zip": "12345", "country": "US", "card_type": "Visa", "expiry_year": 2020, "expiry_month": 12, "first_six": "123456", "last_four": "1234", "vat_number": null, "ip_address": null, "ip_address_country": null } ] }
{ "billings": [ { "id": 1, "first_name": "John", "last_name": "Doe", "company": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state": "CA", "zip": "12345", "country": "US", "card_type": "Visa", "expiry_year": 2020, "expiry_month": 12, "first_six": "123456", "last_four": "1234", "vat_number": null, "ip_address": null, "ip_address_country": null } ] }
{ "billings": [ { "id": 1, "first_name": "John", "last_name": "Doe", "company": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state": "CA", "zip": "12345", "country": "US", "card_type": "Visa", "expiry_year": 2020, "expiry_month": 12, "first_six": "123456", "last_four": "1234", "vat_number": null, "ip_address": null, "ip_address_country": null } ] }
{ "billings": [ { "id": 1, "first_name": "John", "last_name": "Doe", "company": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state": "CA", "zip": "12345", "country": "US", "card_type": "Visa", "expiry_year": 2020, "expiry_month": 12, "first_six": "123456", "last_four": "1234", "vat_number": null, "ip_address": null, "ip_address_country": null } ] }
{ "billings": [ { "id": 1, "first_name": "John", "last_name": "Doe", "company": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state": "CA", "zip": "12345", "country": "US", "card_type": "Visa", "expiry_year": 2020, "expiry_month": 12, "first_six": "123456", "last_four": "1234", "vat_number": null, "ip_address": null, "ip_address_country": null } ] }
{ "billings": [ { "id": 1, "first_name": "John", "last_name": "Doe", "company": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state": "CA", "zip": "12345", "country": "US", "card_type": "Visa", "expiry_year": 2020, "expiry_month": 12, "first_six": "123456", "last_four": "1234", "vat_number": null, "ip_address": null, "ip_address_country": null } ] }

get

Retrieves a billing from a previously created billing object.

To retrieve a billing object you must supply the uniqe identifier id to billing's resouce link /api/v1/billings/ id

HTTP Request

GET https://dev.qebot.com/api/v1/billings/<ID>

Returns

Returns an array of a billing.

Update Billing

PUT /api/v1/billings/ id

PATCH /api/v1/billings/ id

Example Request

# User id needs to be appended after api uri curl "https://dev.qebot.com/api/v1/billings/<ID>" -X PATCH -u "<USERNAME>:<API_TOKEN>" -d first_name=John -d last_name=Doe -d role_id=2

Example Response

{ "billings": [ { "id": 1, "first_name": "John", "last_name": "Doe", "company": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state": "CA", "zip": "12345", "country": "US", "card_type": "Visa", "expiry_year": 2020, "expiry_month": 12, "first_six": "123456", "last_four": "1234", "vat_number": null, "ip_address": null, "ip_address_country": null } ] }
{ "billings": [ { "id": 1, "first_name": "John", "last_name": "Doe", "company": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state": "CA", "zip": "12345", "country": "US", "card_type": "Visa", "expiry_year": 2020, "expiry_month": 12, "first_six": "123456", "last_four": "1234", "vat_number": null, "ip_address": null, "ip_address_country": null } ] }
{ "billings": [ { "id": 1, "first_name": "John", "last_name": "Doe", "company": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state": "CA", "zip": "12345", "country": "US", "card_type": "Visa", "expiry_year": 2020, "expiry_month": 12, "first_six": "123456", "last_four": "1234", "vat_number": null, "ip_address": null, "ip_address_country": null } ] }
{ "billings": [ { "id": 1, "first_name": "John", "last_name": "Doe", "company": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state": "CA", "zip": "12345", "country": "US", "card_type": "Visa", "expiry_year": 2020, "expiry_month": 12, "first_six": "123456", "last_four": "1234", "vat_number": null, "ip_address": null, "ip_address_country": null } ] }
{ "billings": [ { "id": 1, "first_name": "John", "last_name": "Doe", "company": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state": "CA", "zip": "12345", "country": "US", "card_type": "Visa", "expiry_year": 2020, "expiry_month": 12, "first_six": "123456", "last_four": "1234", "vat_number": null, "ip_address": null, "ip_address_country": null } ] }
{ "billings": [ { "id": 1, "first_name": "John", "last_name": "Doe", "company": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state": "CA", "zip": "12345", "country": "US", "card_type": "Visa", "expiry_year": 2020, "expiry_month": 12, "first_six": "123456", "last_four": "1234", "vat_number": null, "ip_address": null, "ip_address_country": null } ] }

post post

Updates a billing object.

To update a billing object you must supply the uniqe identifier id to billing's resouce link /api/v1/billings/ id

HTTP Request

PUT https://dev.qebot.com/api/v1/billings/<ID>

PATCH https://dev.qebot.com/api/v1/billings/<ID>

Even though all billing params are optional. If an empty request is passed
an error will be thrown.

Request Arguments

Param Description

first_name string First name of the user on billing info.

last_name string Last name of the user on billing info.

card_number string Credit card number, spaces and dashes are accepted.

company string Name of company on billing info.

address string Address line 1 on billing info.

address2 string Address lin2 on billing info.

city string City of billing on file.

state string State of billing on file.

zip string Zip or postal of billing on file.

country string Country, 2-letter ISO code of billing on file.

card_type string Type of card on billing info. Possible values: (Visa, MasterCard, American Express, Discover, JCB, etc)

zip string Zip or postal of billing on file.

phone string Phone number, this field can be 10 digits.

expiry_month integer Expiration month of billing card on file.

expiry_year integer Expiration year of billing card on file.

first_six integer First six digits of billing card on file.

last_four integer Last four digits of billing card on file.

vat_number string Customer's VAT number.

currency string Currency in which invoices will be posted. Only applicable if this account is enrolled in a plan has a different currency than your site's default.

cvv string Security code or CVV, 3-4 digits STRONGLY RECOMMENDED.

ip_address string Customer's IPv4 address when updating their billing information STRONGLY RECOMMENDED

Returns

Returns an array of a billing info.

Delete Billing

DELETE /api/v1/billings/ id

Example Request

# User id needs to be appended after api uri curl "https://dev.qebot.com/api/v1/billings/<ID>" -X PATCH -u "<USERNAME>:<API_TOKEN>"

Example Response

delete

Deletes a billings object.

To delete a billing object you must supply the uniqe identifier id to billing's resouce link /api/v1/billings/ id

HTTP Request

DELETE https://dev.qebot.com/api/v1/billings/<ID>

When a success is rendered there will be an empty response body. You must examine status code in header to determine validity of the request.

Returns

Returns an empty response.
Status code 204 is a successful response.

A status code of 4XX or 5XX is an unsuccesful response.

Purchases

The purchases resource is the gateway to connect tools to businesses and users. To charge a credit or a debit card, you create a purchase object.

Please take note that all purchases will create a subscription transaction. The transaction will re-occur every month on the first.

Purchase Object

Attribute Description

id integer Internal unique identifier for the object.

payment_date date The occurence of the charged subscription.

brand Brand See Brand object

whitelabel Whitelabel Whitelabel object

business Business See Business object

tool Tool See Tool object

user User See User object

Retrieve a Purchase List

GET /api/v1/purchases

Example Request

# With shell, you can just pass the correct header with each request curl "https://dev.qebot.com/api/v1/purchases" -u "<USERNAME>:<API_TOKEN>"

Example Response

{ "purchases": [ { "id": 1, "payment_date": "2018-12-05T23:40:57+00:00", "brand": { "id": 1, "name": "Brand Name", "status": "active" }, "whitelabel": { "id": 25, "name": "Agency Name", "key": "NT", "section": "001", "domain": "bizbox.newtimes.com", "registration_domain": "phoenixnewtimes.com" }, "business": { "id": 1, "brand_id": 1, "business_name": "Business Name", "category_id": 52, "phone": null, "fax": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state_id": 5, "state_name": "", "country_id": 230, "zipcode": "85034", "email": null, "website": "", "status": "active" }, "tool": { "id": 2, "tool": "Social Media Dashboard", "plan_code": "social_manager", "amount": 25 }, "user": { "id": 1036, "parent_id": 0, "first_name": "John", "last_name": "Doe", "username": "john.doe@example.com", "role_id": 2, "ip": null, "created_date": "2018-11-22T01:02:10+00:00", "status": "active" } }, {...} ] }
{ "purchases": [ { "id": 1, "payment_date": "2018-12-05T23:40:57+00:00", "brand": { "id": 1, "name": "Brand Name", "status": "active" }, "whitelabel": { "id": 25, "name": "Agency Name", "key": "NT", "section": "001", "domain": "bizbox.newtimes.com", "registration_domain": "phoenixnewtimes.com" }, "business": { "id": 1, "brand_id": 1, "business_name": "Business Name", "category_id": 52, "phone": null, "fax": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state_id": 5, "state_name": "", "country_id": 230, "zipcode": "85034", "email": null, "website": "", "status": "active" }, "tool": { "id": 2, "tool": "Social Media Dashboard", "plan_code": "social_manager", "amount": 25 }, "user": { "id": 1036, "parent_id": 0, "first_name": "John", "last_name": "Doe", "username": "john.doe@example.com", "role_id": 2, "ip": null, "created_date": "2018-11-22T01:02:10+00:00", "status": "active" } }, {...} ] }
{ "purchases": [ { "id": 1, "payment_date": "2018-12-05T23:40:57+00:00", "brand": { "id": 1, "name": "Brand Name", "status": "active" }, "whitelabel": { "id": 25, "name": "Agency Name", "key": "NT", "section": "001", "domain": "bizbox.newtimes.com", "registration_domain": "phoenixnewtimes.com" }, "business": { "id": 1, "brand_id": 1, "business_name": "Business Name", "category_id": 52, "phone": null, "fax": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state_id": 5, "state_name": "", "country_id": 230, "zipcode": "85034", "email": null, "website": "", "status": "active" }, "tool": { "id": 2, "tool": "Social Media Dashboard", "plan_code": "social_manager", "amount": 25 }, "user": { "id": 1036, "parent_id": 0, "first_name": "John", "last_name": "Doe", "username": "john.doe@example.com", "role_id": 2, "ip": null, "created_date": "2018-11-22T01:02:10+00:00", "status": "active" } }, {...} ] }
{ "purchases": [ { "id": 1, "payment_date": "2018-12-05T23:40:57+00:00", "brand": { "id": 1, "name": "Brand Name", "status": "active" }, "whitelabel": { "id": 25, "name": "Agency Name", "key": "NT", "section": "001", "domain": "bizbox.newtimes.com", "registration_domain": "phoenixnewtimes.com" }, "business": { "id": 1, "brand_id": 1, "business_name": "Business Name", "category_id": 52, "phone": null, "fax": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state_id": 5, "state_name": "", "country_id": 230, "zipcode": "85034", "email": null, "website": "", "status": "active" }, "tool": { "id": 2, "tool": "Social Media Dashboard", "plan_code": "social_manager", "amount": 25 }, "user": { "id": 1036, "parent_id": 0, "first_name": "John", "last_name": "Doe", "username": "john.doe@example.com", "role_id": 2, "ip": null, "created_date": "2018-11-22T01:02:10+00:00", "status": "active" } }, {...} ] }
{ "purchases": [ { "id": 1, "payment_date": "2018-12-05T23:40:57+00:00", "brand": { "id": 1, "name": "Brand Name", "status": "active" }, "whitelabel": { "id": 25, "name": "Agency Name", "key": "NT", "section": "001", "domain": "bizbox.newtimes.com", "registration_domain": "phoenixnewtimes.com" }, "business": { "id": 1, "brand_id": 1, "business_name": "Business Name", "category_id": 52, "phone": null, "fax": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state_id": 5, "state_name": "", "country_id": 230, "zipcode": "85034", "email": null, "website": "", "status": "active" }, "tool": { "id": 2, "tool": "Social Media Dashboard", "plan_code": "social_manager", "amount": 25 }, "user": { "id": 1036, "parent_id": 0, "first_name": "John", "last_name": "Doe", "username": "john.doe@example.com", "role_id": 2, "ip": null, "created_date": "2018-11-22T01:02:10+00:00", "status": "active" } }, {...} ] }
{ "purchases": [ { "id": 1, "payment_date": "2018-12-05T23:40:57+00:00", "brand": { "id": 1, "name": "Brand Name", "status": "active" }, "whitelabel": { "id": 25, "name": "Agency Name", "key": "NT", "section": "001", "domain": "bizbox.newtimes.com", "registration_domain": "phoenixnewtimes.com" }, "business": { "id": 1, "brand_id": 1, "business_name": "Business Name", "category_id": 52, "phone": null, "fax": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state_id": 5, "state_name": "", "country_id": 230, "zipcode": "85034", "email": null, "website": "", "status": "active" }, "tool": { "id": 2, "tool": "Social Media Dashboard", "plan_code": "social_manager", "amount": 25 }, "user": { "id": 1036, "parent_id": 0, "first_name": "John", "last_name": "Doe", "username": "john.doe@example.com", "role_id": 2, "ip": null, "created_date": "2018-11-22T01:02:10+00:00", "status": "active" } }, {...} ] }

get

Retrieves a list of subscriptions purchases

HTTP Request

GET https://dev.qebot.com/api/v1/purchases

Returns

Returns an array of purchases.

Create a Purchase

POST /api/v1/purchases

Example Request

# With shell, you can just pass the correct header with each request curl "https://dev.qebot.com/api/v1/purchases" -X POST -u "<USERNAME>:<API_TOKEN>" -d first_name=Jong -d last_name=Doe -d tool_id=1 -d business_id=1 -d billing[id]=1

Example Response

{ "purchases": [ { "id": 1, "payment_date": "2018-12-05T23:40:57+00:00", "brand": { "id": 1, "name": "Brand Name", "status": "active" }, "whitelabel": { "id": 25, "name": "Agency Name", "key": "NT", "section": "001", "domain": "bizbox.newtimes.com", "registration_domain": "phoenixnewtimes.com" }, "business": { "id": 1, "brand_id": 1, "business_name": "Business Name", "category_id": 52, "phone": null, "fax": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state_id": 5, "state_name": "", "country_id": 230, "zipcode": "85034", "email": null, "website": "", "status": "active" }, "tool": { "id": 2, "tool": "Social Media Dashboard", "plan_code": "social_manager", "amount": 25 }, "user": { "id": 1036, "parent_id": 0, "first_name": "John", "last_name": "Doe", "username": "john.doe@example.com", "role_id": 2, "ip": null, "created_date": "2018-11-22T01:02:10+00:00", "status": "active" } } ] }
{ "purchases": [ { "id": 1, "payment_date": "2018-12-05T23:40:57+00:00", "brand": { "id": 1, "name": "Brand Name", "status": "active" }, "whitelabel": { "id": 25, "name": "Agency Name", "key": "NT", "section": "001", "domain": "bizbox.newtimes.com", "registration_domain": "phoenixnewtimes.com" }, "business": { "id": 1, "brand_id": 1, "business_name": "Business Name", "category_id": 52, "phone": null, "fax": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state_id": 5, "state_name": "", "country_id": 230, "zipcode": "85034", "email": null, "website": "", "status": "active" }, "tool": { "id": 2, "tool": "Social Media Dashboard", "plan_code": "social_manager", "amount": 25 }, "user": { "id": 1036, "parent_id": 0, "first_name": "John", "last_name": "Doe", "username": "john.doe@example.com", "role_id": 2, "ip": null, "created_date": "2018-11-22T01:02:10+00:00", "status": "active" } } ] }
{ "purchases": [ { "id": 1, "payment_date": "2018-12-05T23:40:57+00:00", "brand": { "id": 1, "name": "Brand Name", "status": "active" }, "whitelabel": { "id": 25, "name": "Agency Name", "key": "NT", "section": "001", "domain": "bizbox.newtimes.com", "registration_domain": "phoenixnewtimes.com" }, "business": { "id": 1, "brand_id": 1, "business_name": "Business Name", "category_id": 52, "phone": null, "fax": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state_id": 5, "state_name": "", "country_id": 230, "zipcode": "85034", "email": null, "website": "", "status": "active" }, "tool": { "id": 2, "tool": "Social Media Dashboard", "plan_code": "social_manager", "amount": 25 }, "user": { "id": 1036, "parent_id": 0, "first_name": "John", "last_name": "Doe", "username": "john.doe@example.com", "role_id": 2, "ip": null, "created_date": "2018-11-22T01:02:10+00:00", "status": "active" } } ] }
{ "purchases": [ { "id": 1, "payment_date": "2018-12-05T23:40:57+00:00", "brand": { "id": 1, "name": "Brand Name", "status": "active" }, "whitelabel": { "id": 25, "name": "Agency Name", "key": "NT", "section": "001", "domain": "bizbox.newtimes.com", "registration_domain": "phoenixnewtimes.com" }, "business": { "id": 1, "brand_id": 1, "business_name": "Business Name", "category_id": 52, "phone": null, "fax": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state_id": 5, "state_name": "", "country_id": 230, "zipcode": "85034", "email": null, "website": "", "status": "active" }, "tool": { "id": 2, "tool": "Social Media Dashboard", "plan_code": "social_manager", "amount": 25 }, "user": { "id": 1036, "parent_id": 0, "first_name": "John", "last_name": "Doe", "username": "john.doe@example.com", "role_id": 2, "ip": null, "created_date": "2018-11-22T01:02:10+00:00", "status": "active" } } ] }
{ "purchases": [ { "id": 1, "payment_date": "2018-12-05T23:40:57+00:00", "brand": { "id": 1, "name": "Brand Name", "status": "active" }, "whitelabel": { "id": 25, "name": "Agency Name", "key": "NT", "section": "001", "domain": "bizbox.newtimes.com", "registration_domain": "phoenixnewtimes.com" }, "business": { "id": 1, "brand_id": 1, "business_name": "Business Name", "category_id": 52, "phone": null, "fax": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state_id": 5, "state_name": "", "country_id": 230, "zipcode": "85034", "email": null, "website": "", "status": "active" }, "tool": { "id": 2, "tool": "Social Media Dashboard", "plan_code": "social_manager", "amount": 25 }, "user": { "id": 1036, "parent_id": 0, "first_name": "John", "last_name": "Doe", "username": "john.doe@example.com", "role_id": 2, "ip": null, "created_date": "2018-11-22T01:02:10+00:00", "status": "active" } } ] }
{ "purchasess": [ { "id": 1, "payment_date": "2018-12-05T23:40:57+00:00", "brand": { "id": 1, "name": "Brand Name", "status": "active" }, "whitelabel": { "id": 25, "name": "Agency Name", "key": "NT", "section": "001", "domain": "bizbox.newtimes.com", "registration_domain": "phoenixnewtimes.com" }, "business": { "id": 1, "brand_id": 1, "business_name": "Business Name", "category_id": 52, "phone": null, "fax": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state_id": 5, "state_name": "", "country_id": 230, "zipcode": "85034", "email": null, "website": "", "status": "active" }, "tool": { "id": 2, "tool": "Social Media Dashboard", "plan_code": "social_manager", "amount": 25 }, "user": { "id": 1036, "parent_id": 0, "first_name": "John", "last_name": "Doe", "username": "john.doe@example.com", "role_id": 2, "ip": null, "created_date": "2018-11-22T01:02:10+00:00", "status": "active" } } ] }

post

Create a purchase object.

HTTP Request

POST https://dev.qebot.com/api/v1/purchases

If you supply a billing id there is no need to fill out the rest of the billing information. Specifying a billing id is simply using a previously stored billing account.

The dot notation indicates that the property is one level deep inside a hash.

Request Arguments

Param Description

tool_id stringrequired A unique identifier of the tool you want to purchase. See Retrieve A Tool List to see tools available.

first_name stringrequired First name of the user on this subscription account.

last_name stringrequired Last name of the user on this subscription account.

business_id numberrequired The identifier number for business that is making the purchase.

prorate boolean Optional field to be used only when needing to bypass the 60 second limit on creating subscriptions.

billing.id string Unique identifier of billing acconnt on file you want to reuse.

billing.card_number string Credit card number, spaces and dashes are accepted. (required only if no billing id is specified).

billing.exipry_month integer Expiration month of billing card on file. (required only if no billing id is specified).

billing.exipry_year integer Expiration year of billing card on file. (required only if no billing id is specified).

billing.cvv string Security code or CVV, 3-4 digits STRONGLY RECOMMENDED.

billing.address string Address line 1 on billing info.

billing.address2 string Address lin2 on billing info.

billing.city string City of billing on file.

billing.state string State of billing on file.

billing.zip string Zip or postal of billing on file.

billing.country string Country, 2-letter ISO code of billing on file.

Returns

Returns an array of a billing info.

Retrieve a Purchase

GET /api/v1/purchases/ id

Example Request

# With shell, you can just pass the correct header with each request curl "https://dev.qebot.com/api/v1/purchases/<ID>" -u "<USERNAME>:<API_TOKEN>"

Example Response

{ "purchases": [ { "id": 1, "payment_date": "2018-12-05T23:40:57+00:00", "brand": { "id": 1, "name": "Brand Name", "status": "active" }, "whitelabel": { "id": 25, "name": "Agency Name", "key": "NT", "section": "001", "domain": "bizbox.newtimes.com", "registration_domain": "phoenixnewtimes.com" }, "business": { "id": 1, "brand_id": 1, "business_name": "Business Name", "category_id": 52, "phone": null, "fax": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state_id": 5, "state_name": "", "country_id": 230, "zipcode": "85034", "email": null, "website": "", "status": "active" }, "tool": { "id": 2, "tool": "Social Media Dashboard", "plan_code": "social_manager", "amount": 25 }, "user": { "id": 1036, "parent_id": 0, "first_name": "John", "last_name": "Doe", "username": "john.doe@example.com", "role_id": 2, "ip": null, "created_date": "2018-11-22T01:02:10+00:00", "status": "active" } } ] }
{ "purchases": [ { "id": 1, "payment_date": "2018-12-05T23:40:57+00:00", "brand": { "id": 1, "name": "Brand Name", "status": "active" }, "whitelabel": { "id": 25, "name": "Agency Name", "key": "NT", "section": "001", "domain": "bizbox.newtimes.com", "registration_domain": "phoenixnewtimes.com" }, "business": { "id": 1, "brand_id": 1, "business_name": "Business Name", "category_id": 52, "phone": null, "fax": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state_id": 5, "state_name": "", "country_id": 230, "zipcode": "85034", "email": null, "website": "", "status": "active" }, "tool": { "id": 2, "tool": "Social Media Dashboard", "plan_code": "social_manager", "amount": 25 }, "user": { "id": 1036, "parent_id": 0, "first_name": "John", "last_name": "Doe", "username": "john.doe@example.com", "role_id": 2, "ip": null, "created_date": "2018-11-22T01:02:10+00:00", "status": "active" } } ] }
{ "purchases": [ { "id": 1, "payment_date": "2018-12-05T23:40:57+00:00", "brand": { "id": 1, "name": "Brand Name", "status": "active" }, "whitelabel": { "id": 25, "name": "Agency Name", "key": "NT", "section": "001", "domain": "bizbox.newtimes.com", "registration_domain": "phoenixnewtimes.com" }, "business": { "id": 1, "brand_id": 1, "business_name": "Business Name", "category_id": 52, "phone": null, "fax": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state_id": 5, "state_name": "", "country_id": 230, "zipcode": "85034", "email": null, "website": "", "status": "active" }, "tool": { "id": 2, "tool": "Social Media Dashboard", "plan_code": "social_manager", "amount": 25 }, "user": { "id": 1036, "parent_id": 0, "first_name": "John", "last_name": "Doe", "username": "john.doe@example.com", "role_id": 2, "ip": null, "created_date": "2018-11-22T01:02:10+00:00", "status": "active" } } ] }
{ "purchases": [ { "id": 1, "payment_date": "2018-12-05T23:40:57+00:00", "brand": { "id": 1, "name": "Brand Name", "status": "active" }, "whitelabel": { "id": 25, "name": "Agency Name", "key": "NT", "section": "001", "domain": "bizbox.newtimes.com", "registration_domain": "phoenixnewtimes.com" }, "business": { "id": 1, "brand_id": 1, "business_name": "Business Name", "category_id": 52, "phone": null, "fax": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state_id": 5, "state_name": "", "country_id": 230, "zipcode": "85034", "email": null, "website": "", "status": "active" }, "tool": { "id": 2, "tool": "Social Media Dashboard", "plan_code": "social_manager", "amount": 25 }, "user": { "id": 1036, "parent_id": 0, "first_name": "John", "last_name": "Doe", "username": "john.doe@example.com", "role_id": 2, "ip": null, "created_date": "2018-11-22T01:02:10+00:00", "status": "active" } } ] }
{ "purchases": [ { "id": 1, "payment_date": "2018-12-05T23:40:57+00:00", "brand": { "id": 1, "name": "Brand Name", "status": "active" }, "whitelabel": { "id": 25, "name": "Agency Name", "key": "NT", "section": "001", "domain": "bizbox.newtimes.com", "registration_domain": "phoenixnewtimes.com" }, "business": { "id": 1, "brand_id": 1, "business_name": "Business Name", "category_id": 52, "phone": null, "fax": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state_id": 5, "state_name": "", "country_id": 230, "zipcode": "85034", "email": null, "website": "", "status": "active" }, "tool": { "id": 2, "tool": "Social Media Dashboard", "plan_code": "social_manager", "amount": 25 }, "user": { "id": 1036, "parent_id": 0, "first_name": "John", "last_name": "Doe", "username": "john.doe@example.com", "role_id": 2, "ip": null, "created_date": "2018-11-22T01:02:10+00:00", "status": "active" } } ] }
{ "purchases": [ { "id": 1, "payment_date": "2018-12-05T23:40:57+00:00", "brand": { "id": 1, "name": "Brand Name", "status": "active" }, "whitelabel": { "id": 25, "name": "Agency Name", "key": "NT", "section": "001", "domain": "bizbox.newtimes.com", "registration_domain": "phoenixnewtimes.com" }, "business": { "id": 1, "brand_id": 1, "business_name": "Business Name", "category_id": 52, "phone": null, "fax": null, "address": "123 Fake St", "address2": "", "city": "San Francisco", "state_id": 5, "state_name": "", "country_id": 230, "zipcode": "85034", "email": null, "website": "", "status": "active" }, "tool": { "id": 2, "tool": "Social Media Dashboard", "plan_code": "social_manager", "amount": 25 }, "user": { "id": 1036, "parent_id": 0, "first_name": "John", "last_name": "Doe", "username": "john.doe@example.com", "role_id": 2, "ip": null, "created_date": "2018-11-22T01:02:10+00:00", "status": "active" } } ] }

get

Retrieves a purchase from a previously created purchase object.

To retrieve a purchase object you must supply the uniqe identifier id to purchase's resouce link /api/v1/purchases/ id

HTTP Request

GET https://dev.qebot.com/api/v1/purchases/<ID>

Returns

Returns an array of a purchase.

Param		Description
firstName	string	First name of the customer.
lastName	string	Last name of the customer.
jobTitle	string	Job Title of the customer.
waytoContact	string	Way to contact customer.
leadStatus	integer	Lead Status look up code.
leadStatusMeaning	string	Lead Status text.
leadSource	integer	Lead Source code.
leadSourceMeaning	string	Lead Source name.
leadTypeId	integer	Lead type identifier.
leadTypeName	string	Lead type name.
referredById	integer	Identifier of person who referred the customer
referredByName	string	Name of the person who referred the customer
assigneeObjectRefId	integer	Identifier of the person who is assigned this customer
assigneeObjectRefName	string	Name of the person who is assigned this customer reference
Description	string	Name of the person who is assigned this customer reference
Labels	labels	Labels object.
skypeName	string	Name of customer's skype handle.
isUnsubscribed	string	Is customer unsubscribed. Possible values: (Y, N).
potentialAmount	decimal	Possible amount to charge customer.
estimatedCloseDate	date	Estimated close date from customer.
leadRank	string	Rank of the lead.
leadRankMeaning	string	The test of lead ranking.
campaignId	integer	Identifier of campaign.
campaignName	string	Name of campaign.
territoryId	integer	Identifier of territory.
territoryName	string	Name of territory.
marketId	integer	Identifier of market.
marketName	string	Name of market.
segmentId	integer	Identifier of segment.
segmentName	string	Name of segment.
accountId	integer	Identifier of account.
accountName	string	Name of account.
companyName	string	Name of account.
employeeRangeId	integer	Identifier of employee range.
employeeRange	string	Name of employee range.
annualRevenue	string	Name of annual revenue.
industry	string	Name of annual industry.
industryName	string	Name of annual industry.
ownership	string	The name of who owns the customer lead.
website	string	The website URL
faceBookURL	string	Your facebook website URL
linkedInURL	string	Your linkedin website URL
twitterURL	string	Your twitter website URL
phoneNumbers	phoneNumbers	Phone Numbers object.
emailAddresses	emailAddresses	Email Addresses object.
addresses	addresses	Addresses object.
customAttributes	customAttributes	Custom Attributes object.

Attribute		Description
id	integer	Internal unique identifier for the object.
tool	string	The name of the tool
plan_code	string	The code used for purchasing a tool.
amount	decimal	The amount the tool costs.

Param		Description
first_name	string`required`	First name of the user on billing info.
last_name	string`required`	Last name of the user on billing info.
card_number	string`required`	Credit card number, spaces and dashes are accepted.
company	string	Name of company on billing info.
address	string	Address line 1 on billing info.
address2	string	Address lin2 on billing info.
city	string	City of billing on file.
state	string	State of billing on file.
zip	string	Zip or postal of billing on file.
country	string	Country, 2-letter ISO code of billing on file.
card_type	string	Type of card on billing info. Possible values: (Visa, MasterCard, American Express, Discover, JCB, etc)
zip	string	Zip or postal of billing on file.
phone	string	Phone number, this field can be 10 digits.
expiry_month	integer`required`	Expiration month of billing card on file.
expiry_year	integer`required`	Expiration year of billing card on file.
first_six	integer	First six digits of billing card on file.
last_four	integer	Last four digits of billing card on file.
vat_number	string	Customer's VAT number.
currency	string	Currency in which invoices will be posted. Only applicable if this account is enrolled in a plan has a different currency than your site's default.
cvv	string	Security code or CVV, 3-4 digits STRONGLY RECOMMENDED.
ip_address	string	Customer's IPv4 address when updating their billing information STRONGLY RECOMMENDED

Attribute		Description
id	integer	Internal unique identifier for the object.
payment_date	date	The occurence of the charged subscription.
brand	Brand	See Brand object
whitelabel	Whitelabel	Whitelabel object
business	Business	See Business object
tool	Tool	See Tool object
user	User	See User object

Param		Description
tool_id	string`required`	A unique identifier of the tool you want to purchase. See Retrieve A Tool List to see tools available.
first_name	string`required`	First name of the user on this subscription account.
last_name	string`required`	Last name of the user on this subscription account.
business_id	number`required`	The identifier number for business that is making the purchase.
prorate	boolean	Optional field to be used only when needing to bypass the 60 second limit on creating subscriptions.
billing.id	string	Unique identifier of billing acconnt on file you want to reuse.
billing.card_number	string	Credit card number, spaces and dashes are accepted. (`required` only if no billing id is specified).
billing.exipry_month	integer	Expiration month of billing card on file. (`required` only if no billing id is specified).
billing.exipry_year	integer	Expiration year of billing card on file. (`required` only if no billing id is specified).
billing.cvv	string	Security code or CVV, 3-4 digits STRONGLY RECOMMENDED.
billing.address	string	Address line 1 on billing info.
billing.address2	string	Address lin2 on billing info.
billing.city	string	City of billing on file.
billing.state	string	State of billing on file.
billing.zip	string	Zip or postal of billing on file.
billing.country	string	Country, 2-letter ISO code of billing on file.