Legacy Docs

Gigs

Retrieve information specific to gig employments.

#The gig object

Attributes
  • idstring (uuid)

    Unique ID of the gig assignment.

  • accountstring (uuid)

    Unique ID of the account associated with the gig assignment.

  • employerstring

    Employer name.

  • created_atstring (datetime)

    Timestamp (ISO 8601) when the gig object was created.

  • updated_atstring (datetime)

    Timestamp (ISO 8601) when a property value of the gig object most recently changed.

  • statusstring (enum)

    Current state of the gig assignment.

  • typestring (enum)

    The type of gig assignment.

  • task_countinteger

    Number of discrete tasks in the gig assignment.

    Typically one task (trip, delivery, etc.) per assignment, but may be more than one in special circumstances, such as a friend being added to a rideshare trip. Returns null if the platform returns only aggregate data instead of per task data.

  • start_datetimestring (datetime)

    Timestamp (ISO 8601) when the gig assignment started.

  • end_datetimestring (datetime)

    Timestamp (ISO 8601) when the gig assignment ended.

  • all_datetimesobject

  • request_atstring (datetime)

    Timestamp (ISO 8601) when the gig assignment was created.

  • accept_atstring (datetime)

    Timestamp (ISO 8601) when the gig assignment was accepted.

  • pickup_atstring (datetime)

    Timestamp (ISO 8601) when "package" (rider, food, or similar) was obtained.

  • dropoff_atstring (datetime)

    Timestamp (ISO 8601) when "package" (rider, food, or similar) was delivered.

  • cancel_atstring (datetime)

    Timestamp (ISO 8601) when the gig assignment was cancelled.

  • shift_startstring (datetime)

    Timestamp (ISO 8601) when the work shift started.

  • shift_endstring (datetime)

    Timestamp (ISO 8601) when the work shift ended.

  • breaksarray of objects

  • break_startstring (datetime)

    Timestamp (ISO 8601) when the break started.

  • break_endstring (datetime)

    Timestamp (ISO 8601) when the break ended.

  • durationinteger

    Total time of the gig assignment (in seconds).

  • timezonestring (timezone)

    Timezone (IANA) where the gig assignment took place.

  • earning_typestring (enum)

    The earnings category.

  • start_locationobject

  • latstring (degrees)

    Latitude (ISO 6709) where the gig assignment started.

  • lngstring (degrees)

    Longitude (ISO 6709) where the gig assignment started.

  • formatted_addressstring

    Full address of where the gig assignment started.

  • end_locationobject

  • latstring (degrees)

    Latitude (ISO 6709) where the gig assignment ended.

  • lngstring (degrees)

    Longitude (ISO 6709) where the gig assignment ended.

  • formatted_addressstring

    Full address of where the gig assignment ended.

  • distancestring

    Distance traveled during the gig assignment.

  • distance_unitstring (enum)

    Unit of the distance traveled.

  • metadataobject

    Additional, non-categorized information.

  • circumstancesobject

    Metadata specific to the gig platform, such as whether the assignment occurred during peak hours.

  • incomeobject

  • currencystring

    Currency code (ISO 4217).

  • total_chargestring

    Total amount charged to the customer ( fees + total ).

  • feesstring

    Fees charged to the customer by the gig platform.

  • totalstring

    Total earnings received by the gig employee ( pay + tips + bonus ).

  • paystring

    Earnings related to the assignment received by the gig employee.

  • tipsstring

    Tips received by the gig employee.

  • bonusstring

    Bonus earnings received by the gig employee.

  • income_ratesobject

    Amount earned by the gig employee per hour or per mile.

    Values are not calculated, and are only returned if directly provided by the gig platform.

  • hourstring

    Earnings per hour. *Not calculated

  • milestring

    Earnings per mile. *Not calculated

Example
1{
2  "id": "0187dbfa-6f5e-a33a-af26-7e12ff408fea",
3  "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
4  "employer": "GigAndGo",
5  "created_at": "2023-03-08T08:31:37.037Z",
6  "updated_at": "2023-03-08T08:31:37.037Z",
7  "status": "completed",
8  "type": "rideshare",
9  "task_count": 1,
10  "start_datetime": "2023-03-08T08:08:57Z",
11  "end_datetime": "2023-03-08T08:31:36Z",
12  "all_datetimes": {
13    "request_at": "2023-03-08T08:08:57Z",
14    "accept_at": "2023-03-08T08:09:38Z",
15    "pickup_at": "2023-03-08T08:12:57Z",
16    "dropoff_at": "2023-03-08T08:31:36Z",
17    "cancel_at": null,
18    "shift_start": null,
19    "shift_end": null,
20    "breaks": []
21  },
22  "duration": 2659,
23  "timezone": "America/New_York",
24  "earning_type": "work",
25  "start_location": {
26    "lat": "40.65932120164202",
27    "lng": "-73.8526246331782",
28    "formatted_address": "201 North W St, New York, NY 10014, US"
29  },
30  "end_location": {
31    "lat": "40.689177462234504",
32    "lng": "-73.89453884284752",
33    "formatted_address": "102 South E St, New York, NY 10002, US"
34  },
35  "distance": "1.80",
36  "distance_unit": "miles",
37  "metadata": {},
38  "circumstances": {
39    "is_pool": false,
40    "is_rush": false,
41    "is_surge": true,
42    "service_type": "Comfort Ride",
43    "position": null
44  },
45  "income": {
46    "currency": "USD",
47    "total_charge": "50.07",
48    "fees": "8.37",
49    "total": "41.70",
50    "pay": "35.28",
51    "tips": "6.42",
52    "bonus": "0.00"
53  },
54  "income_rates": {
55    "hour": "92.70",
56    "mile": "20.20"
57  }
58}

#Retrieve a gig

get/v2/gigs/{id}

Retrieves a gig object.

Path parameters
  • idstring (uuid)
    required

    ID of the gig object to be retrieved.

Example Request
1curl --request GET \
2     --url https://api.argyle.com/v2/gigs/{id} \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'
Example Response
1{
2  "id": "0187dbfa-6f5e-a33a-af26-7e12ff408fea",
3  "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
4  "employer": "GigAndGo",
5  "created_at": "2023-03-08T08:31:37.037Z",
6  "updated_at": "2023-03-08T08:31:37.037Z",
7  "status": "completed",
8  "type": "rideshare",
9  "task_count": 1,
10  "start_datetime": "2023-03-08T08:08:57Z",
11  "end_datetime": "2023-03-08T08:31:36Z",
12  "all_datetimes": {
13    "request_at": "2023-03-08T08:08:57Z",
14    "accept_at": "2023-03-08T08:09:38Z",
15    "pickup_at": "2023-03-08T08:12:57Z",
16    "dropoff_at": "2023-03-08T08:31:36Z",
17    "cancel_at": null,
18    "shift_start": null,
19    "shift_end": null,
20    "breaks": []
21  },
22  "duration": 2659,
23  "timezone": "America/New_York",
24  "earning_type": "work",
25  "start_location": {
26    "lat": "40.65932120164202",
27    "lng": "-73.8526246331782",
28    "formatted_address": "201 North W St, New York, NY 10014, US"
29  },
30  "end_location": {
31    "lat": "40.689177462234504",
32    "lng": "-73.89453884284752",
33    "formatted_address": "102 South E St, New York, NY 10002, US"
34  },
35  "distance": "1.80",
36  "distance_unit": "miles",
37  "metadata": {},
38  "circumstances": {
39    "is_pool": false,
40    "is_rush": false,
41    "is_surge": true,
42    "service_type": "Comfort Ride",
43    "position": null
44  },
45  "income": {
46    "currency": "USD",
47    "total_charge": "50.07",
48    "fees": "8.37",
49    "total": "41.70",
50    "pay": "35.28",
51    "tips": "6.42",
52    "bonus": "0.00"
53  },
54  "income_rates": {
55    "hour": "92.70",
56    "mile": "20.20"
57  }
58}

#List all gigs

get/v2/gigs

Returns an array of all gig objects.

Query parameters
  • accountstring (uuid)
    optional

    Filter by account ID.

  • userstring (uuid)
    optional

    Filter by user ID.

  • from_start_datetimestring (datetime)
    optional

    Filter by gigs with a start_datetime on or after this timestamp (ISO 8601).

  • to_start_datetimestring (datetime)
    optional

    Filter by gigs with a start_datetime on or before this timestamp (ISO 8601).

  • limitinteger
    optional

    Number of gig objects returned per page. Default: 10. Maximum: 200.

Example Request
1curl --request GET \
2     --url https://api.argyle.com/v2/gigs?limit=2 \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'
Example Response
1[
2  {
3    "id": "0187b43a-35fa-56e2-1a95-f7e4232a4b3a",
4    "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
5    "employer": "GigAntic",
6    "created_at": "2023-03-15T06:10:25.004Z",
7    "updated_at": "2023-03-15T06:10:25.004Z",
8    "status": "completed",
9    "type": "rideshare",
10    "task_count": 1,
11    "start_datetime": "2023-03-15T05:24:44Z",
12    "end_datetime": "2023-03-15T06:10:24Z",
13    "all_datetimes": {
14      "request_at": "2023-03-15T05:24:44Z",
15      "accept_at": "2023-03-15T05:26:51Z",
16      "pickup_at": "2023-03-15T05:30:46Z",
17      "dropoff_at": "2023-03-15T06:10:24Z",
18      "cancel_at": null,
19      "shift_start": null,
20      "shift_end": null,
21      "breaks": []
22    },
23    "duration": 2740,
24    "timezone": "America/New_York",
25    "earning_type": "work",
26    "start_location": {
27      "lat": "40.61236518213759",
28      "lng": "-73.58345445703922",
29      "formatted_address": "305 East Ave Apt. 980, New York, NY 10006, US"
30    },
31    "end_location": {
32      "lat": "40.693262037420084",
33      "lng": "-73.83205844061759",
34      "formatted_address": "503 Far West Ave Suite 970, New York, NY 10019, US"
35    },
36    "distance": "24.93",
37    "distance_unit": "miles",
38    "metadata": {},
39    "circumstances": {
40      "is_pool": false,
41      "is_rush": false,
42      "is_surge": true,
43      "service_type": "GigAntic XL",
44      "position": null
45    },
46    "income": {
47      "currency": "USD",
48      "total_charge": "34.79",
49      "fees": "9.47",
50      "total": "25.32",
51      "pay": "25.32",
52      "tips": "0.00",
53      "bonus": "0.00"
54    },
55    "income_rates": {
56      "hour": "13.62",
57      "mile": "0.60"
58    }
59  },
60  {
61    "id": "0187dbfa-6f5e-a33a-af26-7e12ff408fea",
62    "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
63    "employer": "GigAndGo",
64    "created_at": "2023-03-08T08:31:37.037Z",
65    "updated_at": "2023-03-08T08:31:37.037Z",
66    "status": "completed",
67    "type": "rideshare",
68    "task_count": 1,
69    "start_datetime": "2023-03-08T08:08:57Z",
70    "end_datetime": "2023-03-08T08:31:36Z",
71    "all_datetimes": {
72      "request_at": "2023-03-08T08:08:57Z",
73      "accept_at": "2023-03-08T08:09:38Z",
74      "pickup_at": "2023-03-08T08:12:57Z",
75      "dropoff_at": "2023-03-08T08:31:36Z",
76      "cancel_at": null,
77      "shift_start": null,
78      "shift_end": null,
79      "breaks": []
80    },
81    "duration": 2659,
82    "timezone": "America/New_York",
83    "earning_type": "work",
84    "start_location": {
85      "lat": "40.65932120164202",
86      "lng": "-73.8526246331782",
87      "formatted_address": "201 North W St, New York, NY 10014, US"
88    },
89    "end_location": {
90      "lat": "40.689177462234504",
91      "lng": "-73.89453884284752",
92      "formatted_address": "102 South E St, New York, NY 10002, US"
93    },
94    "distance": "1.80",
95    "distance_unit": "miles",
96    "metadata": {},
97    "circumstances": {
98      "is_pool": false,
99      "is_rush": false,
100      "is_surge": true,
101      "service_type": "Comfort Ride",
102      "position": null
103    },
104    "income": {
105      "currency": "USD",
106      "total_charge": "50.07",
107      "fees": "8.37",
108      "total": "41.70",
109      "pay": "35.28",
110      "tips": "6.42",
111      "bonus": "0.00"
112    },
113    "income_rates": {
114      "hour": "92.70",
115      "mile": "20.20"
116    }
117  }
118]