What is the JobBoy API

The JobBoy API allows automatic creation of small tasks that take a few minutes to complete. Applications made by users can be accepted/rejected by API calls. Below you can find detailed documentation of the API with sample codes provided.

Overview

Base URL

The main url to which you will send all requests is as follows.

https://www.jobboy.com/api/v1

Authentication

Jobboy provides you a Bearar Token to authenticate your account.

Every request you make should contain the Authentication Header along with your Api Key. If you don't have an API Key, you can create one on account setting page.

Example

Accept: application/json
Authorization: Bearer {{ Your API Key }}
                                

Account

Get Your Account Information

This Method Returns your account information

GET https://www.jobboy.com/api/v1/me
Example Request ( PHP & Curl )
                            
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://www.jobboy.com/api/v1/me',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => array(
        'Accept: application/json',
        'Authorization: Bearer {YOUR-API-KEY}'
    ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
                            
                        
Response Body
                            
{
    "id": 1,
    "fullname": "Your Name",
    "email": "your@email",
    "gender": 1,
    "lang": "en",
    "birthdate": null,
    "country": "Your Country {Geonames ID}",
    "address1": "Your Address 1",
    "address2": "Your Address 2",
    "city": "Your City {Geonames ID}",
    "zip": null,
    "state": "Your State {Geonames ID}",
    "candoadultjobs": 0,
    "active": 1,
    "current_balance": 100.000000 {USD Account Balance},
    "referrer": 0,
    "submittask": 0,
    "phone_number": null,
    "callback_url": null
}
                            
                        

JOBS

Get A Job By ID

This method returns the details of a job you created

GET https://www.jobboy.com/api/v1/job/#YOUR-JOB-ID
Example Request ( PHP & Curl )
                                
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://www.jobboy.com/api/v1/job/15341',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => array(
        'Accept: application/json',
        'Authorization: Bearer {YOUR-API-KEY}'
    ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
                            
                        
Response Body
                            
{
    "id": 15341,
    "title": "Hello my friend",
    "total_app": 0,
    "availseats": 24,
    "time": 5,
    "category": 97,
    "price": 0.2,
    "country": "0",
    "expected": [
        "Do this Job"
    ],
    "proof": [
        {
            "desc": "Type Username",
            "type": "text"
        }
    ],
    "image": null,
    "started": 1647741550,
    "status": 1,
    "type": 0,
    "send_tweet": 0,
    "hourseats": 0,
    "hourlock": 0,
    "limitfreqseconds": 0,
    "dec_reason": "",
    "rep_reason": "",
    "slug": "test-x1apm3",
    "created_at": "2022-03-18T00:34:05.000000Z",
    "updated_at": "2022-03-20T01:59:10.000000Z"
}
                            
                        

Get Your Jobs

This method returns the jobs you have created.

GET https://www.jobboy.com/api/v1/jobs/#STATUS#/#PAGE-NUMBER#

PARAMETER : #STATUS#

Parameter Description
all Get All Jobs
1 Online Jobs
3 Finished Jobs
Example Request ( PHP & Curl )
                            
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://www.jobboy.com/api/v1/jobs/all/1',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => array(
        'Accept: application/json',
        'Authorization: Bearer {YOUR-API-KEY}'
    ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
                            
                        
Response Body
                            
[
    {
        "id": 15356,
        "title": "Test Job",
        "total_app": 0,
        "availseats": 100,
        "time": 1,
        "category": 13,
        "price": 0.03,
        "country": "INT",
        "expected": [
            "Do this",
            "And Do This"
        ],
        "proof": [
            {
                "desc": "Screenshot of your profile at ACME website",
                "type": "image"
            },
            {
                "desc": "Send your ip",
                "type": "text"
            }
        ],
        "image": null,
        "started": 0,
        "status": 1,
        "send_tweet": 1,
        "hourseats": 0,
        "hourlock": 0,
        "limitfreqseconds": 0,
        "dec_reason": null,
        "rep_reason": null,
        "created_at": "2022-03-19T09:38:50.000000Z",
        "updated_at": "2022-03-19T09:38:50.000000Z",
        "url": "https://www.jobboy.com/job/test-job-6xwyfl",
        "hide_search_engines": 1
    }
]
                            
                        

Get Countries

This method returns the list of the countries available to create a job

GET https://www.jobboy.com/api/v1/countries
Example Request ( PHP & Curl )
                            
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://www.jobboy.com/api/v1/countries',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => array(
        'Accept: application/json',
        'Authorization: Bearer {YOUR-API-KEY}'
    ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
                            
                        
Response Body
                            
[
    {
        "country_id": "1269750",
        "name": "India",
        "code": "IN",
        "continent": "AS",
        "nameTranslated": "India"
    },
    {
        "country_id": "1282028",
        "name": "Maldives",
        "code": "MV",
        "continent": "AS",
        "nameTranslated": "Maldives"
    },
    {
        "country_id": "1282988",
        "name": "Nepal",
        "code": "NP",
        "continent": "AS",
        "nameTranslated": "Nepal"
    },
    ...
]
                            
                        

Get Categories

This method returns the list of the categories available to create a job

GET https://www.jobboy.com/api/v1/categories
Example Request ( PHP & Curl )
                            
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://www.jobboy.com/api/v1/categories',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => array(
        'Accept: application/json',
        'Authorization: Bearer {YOUR-API-KEY}'
    ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
                            
                        
Response Body
                            
[
    "1": {
        "id": 9,
        "title": "Blog / Website owners",
        "cost": 0.1,
        "slug": "blog-website-owners",
        "text": "",
        "parent": 0,
        "subcat": [
            {
                "id": 47,
                "title": "Banner And Text Link to Website",
                "cost": 0.8,
                "slug": "blog-website-owners/banner-and-text-link-to-website",
                "text": "",
                "parent": 9,
                "subcat": []
            },
            {
                "id": 45,
                "title": "Text Link to Website And Review Up to 50 Words",
                "cost": 0.3,
                "slug": "blog-website-owners/text-link-to-website-and-review-up-to-50-words",
                "text": "",
                "parent": 9,
                "subcat": []
            }
        ]
    },
    ...
]
                            
                        

Create a Job

This method creates a job

POST https://www.jobboy.com/api/v1/jobs/create

Parameters

You need to send following parameters as JSON
Parameter Type Required Description
title String Yes Job Title
price float Yes How much you are willing to pay each person per task. The price must be higher than min price value in related category. You can call the Get Categories Method to get the list of supported categories.
availseats Integer Yes How many people do you want this task done by
country Array or "INT" Value Yes INT is for international, anyone can do this task. To target specific countries, enter the ids of those countries as an array. See Get Countries Method to get the list of supported countries.
category Integer Yes Category id of the job. See the Get Categories Method to get the list of supported categories.
automated 1 or 0 No JobBoy provides automatic checks for some categories. If you use this tool, tasks can be verified and approved automatically.
Supported Categories
  • Send a Tweet ( See Example )

    You must include the required tweet keywords to check as the first element of expected array.

  • Get Likes on Twitter ( See Example )

    You must include the tweet url as the first element the expected array.

  • Get Followers on Twitter ( See Example )

    You must include your twitter account url as the first element the expected array.

time Integer Yes Estimated time to complete the Job in minutes
job_limit Array No How many times this job can be completed in an hour or day. If you do not enter any value, no limit is applied.
Example
10 Tasks per day ["limit"=> 10, "duration"=>"daily"]
10 Tasks per hour ["limit"=> 10, "duration"=>"hourly"]
expected Array Yes Specify the steps required to complete your task. Be clear on specifications and give easy and simple instructions as an array.
proof Array Yes This value must be an Array in JSON format. Supported Proof Types are "text" and "image".
Example
[ { "desc": "Send Me a Screenshot", "type": "image" }, { "desc": "Your Username", "type": "text" } ]
send_tweet 1 or 0 No Set this to 1 to get your campaign tweeted on the official twitter page of @jobboycom.
hide_search_engines 1 or 0 No Set this to 1 to hide your task from search engines & non-members.
get_cost 1 or 0 No Set this to 1 to return the total cost of the task without actually creating the task. The task will not be created if you set this to 1
Example Request ( PHP & Curl )
                            
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://www.jobboy.com/api/v1/jobs/create',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "title" : "Follow me on somewhere",
        "price" : "0.03",
        "country": "INT",
        "availseats": "100",
        "time":"1",
        "category":"13",
        "expected": [
                "Do this",
                "And do this",
                "Then do this"
            ],
        "hourly_limit": 10,
        "proof": [
                {
                    "desc": "Screenshot of your profile at ACME website",
                    "type": "image"
                },
                    {
                    "desc": "Your username",
                    "type": "text"
                }
            ],
        "send_tweet": 1
}',
    CURLOPT_HTTPHEADER => array(
        'Accept: application/json',
        'Authorization: Bearer {YOUR-API-KEY}',
        'Content-Type: application/json'
    ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
                            
                        
Response Body
                            
{
    "result": "ok",
    "cost": 4.875,
    "job_id": 15357
}
                            
                        

Automated Tasks Examples

Example Request for Send Tweet Automed Job ( PHP & Curl )
                                
    $curl = curl_init();

    curl_setopt_array($curl, array(
        CURLOPT_URL => 'https://www.jobboy.com/api/v1/jobs/create',
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => '',
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 0,
        CURLOPT_FOLLOWLOCATION => true,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => 'POST',
        CURLOPT_POSTFIELDS =>'{
            "title" : "Like my Tweet",
            "price" : "0.03",
            "country": "INT",
            "availseats": "100",
            "time":"3",
            "category":"13",
            "automated":"1",
            "expected": [
                    "Your text what do you want users to tweet."
                ],
            "proof": [
                    {
                        "desc": "send_tweet",
                        "type": "send_tweet"
                    }
                ],
            "send_tweet": 1
    }',
        CURLOPT_HTTPHEADER => array(
            'Accept: application/json',
            'Authorization: Bearer {YOUR-API-KEY}',
            'Content-Type: application/json'
        ),
    ));

    $response = curl_exec($curl);

    curl_close($curl);
    echo $response;
                                
                            

** Don't change the proof section for this category

Example Request for Like Tweet Automed Job ( PHP & Curl )
                                
    $curl = curl_init();

    curl_setopt_array($curl, array(
        CURLOPT_URL => 'https://www.jobboy.com/api/v1/jobs/create',
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => '',
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 0,
        CURLOPT_FOLLOWLOCATION => true,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => 'POST',
        CURLOPT_POSTFIELDS =>'{
            "title" : "Like my Tweet",
            "price" : "0.03",
            "country": "INT",
            "availseats": "100",
            "time":"3",
            "category":"114",
            "automated":"1",
            "expected": [
                    "https://twitter.com/Jobboycom/status/1521806850173374467"
                ],
            "proof": [
                    {
                        "desc": "like_tweet",
                        "type": "like_tweet"
                    }
                ],
            "send_tweet": 1
    }',
        CURLOPT_HTTPHEADER => array(
            'Accept: application/json',
            'Authorization: Bearer {YOUR-API-KEY}',
            'Content-Type: application/json'
        ),
    ));

    $response = curl_exec($curl);

    curl_close($curl);
    echo $response;
                                
                            

** Don't change the proof section for this category

Example Request for Create Automated Job to Get Twitter Followers ( PHP & Curl )
                                
    $curl = curl_init();

    curl_setopt_array($curl, array(
        CURLOPT_URL => 'https://www.jobboy.com/api/v1/jobs/create',
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => '',
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 0,
        CURLOPT_FOLLOWLOCATION => true,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => 'POST',
        CURLOPT_POSTFIELDS =>'{
            "title" : "Like my Tweet",
            "price" : "0.03",
            "country": "INT",
            "availseats": "100",
            "time":"3",
            "category":"112",
            "automated":"1",
            "expected": [
                    "https://twitter.com/Jobboycom/status/1521806850173374467"
                ],
            "proof": [
                    {
                        "desc": "tweeter_followers",
                        "type": "tweeter_followers"
                    }
                ],
            "send_tweet": 1
    }',
        CURLOPT_HTTPHEADER => array(
            'Accept: application/json',
            'Authorization: Bearer {YOUR-API-KEY}',
            'Content-Type: application/json'
        ),
    ));

    $response = curl_exec($curl);

    curl_close($curl);
    echo $response;
                                
                            

** Don't change the proof section for this category

Update Job

This method allows you to update your task.

POST https://www.jobboy.com/api/v1/job/#JOB-ID#/update

Parameters

You need to send following parameters as JSON
Parameter Type Required Description
title String No Job Title
time Integer No How long the job takes in minutes.
job_limit Integer No How many times this job can be completed in an hour or day. If you do not enter any value, no limit is applied.
Example
10 Tasks per day ["limit"=> 10, "duration"=>"daily"]
10 Tasks per hour ["limit"=> 10, "duration"=>"hourly"]
expected Array No Specify the steps required to complete your task. Be clear on specifications and give easy and simple instructions as an array.
proof Array No This value must be an Array in JSON format. Supported Proof Types are "text" and "image".
Example
[ { "desc": "Send Me a Screenshot", "type": "image" }, { "desc": "Your Username", "type": "text" } ]
restart_schedule Integer No Restart schedule by seconds. It makes refresh your job memory so same workers can do your job by multiple times. Allowed parameters :
-1 Disable
Minimum : 60 Seconds
Maximum : 31104000 Seconds
Example Request ( PHP & Curl )
                            
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://www.jobboy.com/api/v1/job/12311/update',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "title" : "Follow me on somewhere",
        "time":"1",
        "expected": [
                "Do this",
                "And do this",
                "Then do this"
            ],
        "hourly_limit": 10,
        "proof": [
                {
                    "desc": "Screenshot of your profile at ACME website",
                    "type": "image"
                },
                    {
                    "desc": "Your username",
                    "type": "text"
                }
            ]
}',
    CURLOPT_HTTPHEADER => array(
        'Accept: application/json',
        'Authorization: Bearer {YOUR-API-KEY}',
        'Content-Type: application/json'
    ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
                            
                        
Response Body
                            
{
    "result": "ok",
    "job_id": 15357
}
                            
                        

Add Seats to a Job

This method allows you to add new slots to your task

POST https://www.jobboy.com/api/v1/job/#JOB-ID#/add_seat

Parameters

You need to send following parameters as JSON
Parameter Type Required Description
seat_count Integer Yes Seat Count
Example Request ( PHP & Curl )
                            
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://www.jobboy.com/api/v1/job/15341/add_seat',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "seat_count": 10
    }',
    CURLOPT_HTTPHEADER => array(
        'Accept: application/json',
        'Authorization: Bearer {YOUR-API-KEY}',
        'Content-Type: application/json'
    ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
                            
                        
Response Body
                            
{
    "result": "ok",
    "cost": 2.35,
    "job_id": 15341
}
                            
                        

Pause a Job

This method sets your task as finished and return the remaining balance to your account.

POST https://www.jobboy.com/api/v1/job/#JOB-ID#/pause
Example Request ( PHP & Curl )
                            
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://www.jobboy.com/api/v1/job/15341/pause',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => array(
    'Accept: application/json',
    'Authorization: Bearer {YOUR-API-KEY}'
    ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
                            
                        
Response Body
                            
{
    "result": "ok",
    "job_id": 15341
}
                            
                        

Resume a Job

This method resumes a finished / paused job

POST https://www.jobboy.com/api/v1/job/#JOB-ID#/resume

Parameters

You need to send following parameters as JSON
Parameter Type Required Description
seat_count Integer Yes Seat Count
send_tweet 1 or 0 No If you enter this parameter as 1, your ad will be published on the official twitter page of @jobboycom.
hide_search_engines 1 or 0 No If you enter this parameter as 1, your campaign shows only logged in users.
Example Request ( PHP & Curl )
                            
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://www.jobboy.com/api/v1/job/15341/resume',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "seat_count": "10",
        "send_tweet": "1",
        "hide_search_engines": "1"
    }',
    CURLOPT_HTTPHEADER => array(
        'Accept: application/json',
        'Authorization: Bearer {YOUR-API-KEY}',
        'Content-Type: application/json'
    ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
                            
                        
Response Body
                            
{
    "result": "ok",
    "cost": 2.85,
    "job_id": 15341
}
                            
                        

Restart a Job

This method restarts the job memory and same workers can do the job after the job restarted.

POST https://www.jobboy.com/api/v1/job/#JOB-ID#/restart
Example Request ( PHP & Curl )
                            
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://www.jobboy.com/api/v1/job/15341/restart',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => array(
        'Accept: application/json',
        'Authorization: Bearer {YOUR-API-KEY}',
        'Content-Type: application/json'
    ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
                            
                        
Response Body
                            
{
    "result": "ok",
    "job_id": 15341
}
                            
                        

Get Applications of a job

This method returns the Applications list of your task

GET https://www.jobboy.com/api/v1/job/#JOB-ID#/applications/#STATUS#/#PAGE-NUMBER#

PARAMETER : #STATUS#

Parameter Description
all Get All Jobs
1 Declined Applications
2 Reported Applications
3 Approved Applications
4 Pending Applications
5 Not Completed Applications
Example Request ( PHP & Curl )
                            
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://www.jobboy.com/api/v1/job/15356/applications/4/1', // Getting Pending Applications
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => array(
        'Accept: application/json',
        'Authorization: Bearer {YOUR-API-KEY}'
    ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
                            
                        
Response Body
                            
[
    {
        "id": 501143,
        "jobid": 15356,
        "user_id": 12333,
        "owner_id": 6,
        "email": "worker@workermailaddress.com",
        "proof": "In aliquid quis vel cupiditate.",
        "status": 4,
        "showcause": null,
        "screenshot": null,
        "appdate": 1643857018,
        "screenshot_url": null
    },
    {
        "id": 501142,
        "jobid": 15356,
        "user_id": 12335,
        "owner_id": 6,
        "email": "worker2@workermailaddress2.com",
        "proof": "Iusto consequatur dolorem facilis aspernatur ut.",
        "status": 4,
        "showcause": null,
        "screenshot": null,
        "appdate": 1643857018,
        "screenshot_url": null
    }
]
                            
                        

Get an Application

This method returns an Application by id.

GET https://www.jobboy.com/api/v1/application/#APPLICATION-ID#
Example Request ( PHP & Curl )
                            
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://www.jobboy.com/api/v1/application/501141',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => array(
        'Accept: application/json',
        'Authorization: Bearer {YOUR-API-KEY}'
    ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
                            
                        
Response Body
                            
{
    "id": 501141,
    "jobid": 15356,
    "user_id": 12332,
    "owner_id": 3123311,
    "email": "worker@emailaddress2.com",
    "proof": "Illum fuga vel et molestiae.",
    "status": 1,
    "showcause": "no",
    "screenshot": "[\"590555_0.jpg\",\"590555_1.jpg\"]",
    "appdate": 1643857018,
    "affect_success_rate": 0,
    "screenshot_url": [
        "https://www.jobboy.com/proof_uploads/590555_0.jpg",
        "https://www.jobboy.com/proof_uploads/590555_1.jpg"
    ]
}
                            
                        

Rate an Application

This method allows you to approve/decline an application for a task

POST https://www.jobboy.com/api/v1/application/#APPLICATION-ID#/set

Parameters

The following parameters need to be in JSON
Parameter Type Required Description
status 1 or 3 or 5 Yes Statuses
1 for decline
3 for approve
5 for not complete
If you set a job as not completed, you give the worker a chance to do that job again.
reason String Yes * Decline reason.
* Required if status will be declined or not completed
Example Request ( PHP & Curl )
                            
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://www.jobboy.com/api/v1/application/501141/set',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS =>'{
        "status" : 5,
        "reason": "The job was not done properly. Please correct the deficiencies and try again."
    }',
    CURLOPT_HTTPHEADER => array(
        'Accept: application/json',
        'Authorization: Bearer {YOUR-API-KEY}',
        'Content-Type: application/json'
    ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
                            
                        
Response Body
                            
{
    "result": "ok",
    "app_id": 501141,
}
                            
                        

Callback

Callback Overview

You can have JobBoy to send a callback to the url you specify. You can set the callback url from the Account Settings page.

Job Completed Event

Fires when your task ends.

GET https://YOURCALLBACKURL/?job_id=12331&event=job-finished

Parameters

The following parameters are sent to the callback url with the get method
Parameter Type Description
job_id Integer Job ID
event job-finished Event Idendity

New Task Event

Fires when your task receives a new application.

GET https://YOURCALLBACKURL/?job_id=12331&event=new-application&application_id=1223145

Parameters

The following parameters are sent to the callback url with the get method
Parameter Type Description
job_id Integer Job ID
application_id Integer Application ID
event new-application Event Idendity