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.

    When task_count is greater than 1 (e.g. two pickups in one delivery), the gig object contains aggregated values for the entire gig assignment. Individual task-level details can be found in the task_details object.

  • #
    start_datetimestring (datetime)

    Timestamp (ISO 8601) when the gig assignment started.

  • #
    end_datetimestring (datetime)

    Timestamp (ISO 8601) when the gig assignment ended.

  • #
    all_datetimesobject

    Other timestamps related to the gig assignment.

  • #
    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

    Starting location information for the gig assignment.

  • #
    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

    Ending location information for the gig assignment.

  • #
    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.

  • #
    task_detailsobject

    Task-level details for the gig assignment.

  • #
    eventsarray of objects

    Geographical information and timestamps.

  • #
    order_idstring

    Argyle-added reference ID. Connects events to orders.

    Only available if the underlying gig platform provides a clear link between events and their associated orders (monetary charges).

  • #
    sequencestring

    Counter starting at 1. The sequential ordering of each event, as represented by the gig platform.

  • #
    typestring (enum)

    The type of event.

  • #
    namestring

    Name associated with the geographical location.

    Primarily available for delivery platforms, where name is the pickup establishment (i.e. restaurant name).

  • #
    formatted_addressstring

    Full address of the geographical location.

  • #
    latstring

    Latitude (ISO 6709) of the geographical location.

  • #
    lngstring

    Longitude (ISO 6709) of the geographical location.

  • #
    datetimestring (datetime)

    Timestamp (ISO 8601) of the event.

  • #
    ordersarray of objects

    Payment and earnings information.

  • #
    order_idstring

    Argyle-added reference ID. Connects orders to events.

    Only available if the underlying gig platform provides a clear link between events and their associated orders (monetary charges).

  • #
    sequencestring

    Counter starting at 1. The sequential ordering of each order, as represented by the gig platform.

  • #
    incomeobject

    Payment and earnings information for the order.

  • #
    currencystring

    Currency code (ISO 4217).

  • #
    total_chargestring

    Total amount charged to the customer.

  • #
    customer_pricestring

    Amount the customer paid for the order, not including fees and tips.

    Only available if directly returned by the gig platform.

  • #
    feesstring

    Fees charged to the gig employee by the gig platform.

  • #
    totalstring

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

  • #
    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.

  • #
    otherstring

    Other payments made or received by the gig employee.

    Common examples: refunds (tolls), taxes, partial cash payments, reimbursements, or miscellaneous payments categorized as "other".

    Additional details for other income are listed within metadata in the following format:

    1"metadata": {
    2  "income.other": {
    3    "name": "Taxes: Withholding tax",
    4    "value": "-15.32"
    5  }
    6}

  • #
    distancestring

    Distance traveled during the gig assignment.

  • #
    distance_unitstring (enum)

    Unit of the distance traveled.

  • #
    metadataobject

    Additional, non-categorized information.

    Also contains details for other income, when present.

  • #
    circumstancesobject

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

  • #
    incomeobject

    Payment and earnings information for the gig assignment.

  • #
    currencystring

    Currency code (ISO 4217).

  • #
    total_chargestring

    Total amount charged to the customer.

  • #
    customer_pricestring

    Amount the customer paid for the order, not including fees and tips.

    Only available if directly returned by the gig platform.

  • #
    feesstring

    Fees charged to the gig employee by the gig platform.

  • #
    totalstring

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

  • #
    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.

  • #
    otherstring

    Other payments made or received by the gig employee.

    Common examples: refunds (tolls), taxes, partial cash payments, reimbursements, or miscellaneous payments categorized as "other".

    Additional details for other income are listed within metadata in the following format:

    1"metadata": {
    2  "income.other": {
    3    "name": "Taxes: Withholding tax",
    4    "value": "-15.32"
    5  }
    6}

  • #
    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": "delivery",
9  "task_count": 2,
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  "task_details": {
36    "events": [
37      {
38        "order_id": null,
39        "sequence": "1",
40        "type": "accept",
41        "name": null,
42        "formatted_address": "201 North W St, New York, NY 10014, US",
43        "lat": "40.65932120164202",
44        "lng": "-73.89453884284752",
45        "datetime": "2023-03-08T08:09:38Z"
46      },
47      {
48        "order_id": "1",
49        "sequence": "2",
50        "type": "pickup",
51        "name": "Healthy Snacks",
52        "formatted_address": "150 East N St, New York, NY 10014, US",
53        "lat": "40.673422892136178",
54        "lng": "-73.88931269893891",
55        "datetime": "2023-03-08T08:12:57Z"
56      },
57      {
58        "order_id": "2",
59        "sequence": "3",
60        "type": "pickup",
61        "name": "Gourmet Desserts",
62        "formatted_address": "182 East N St, New York, NY 10014, US",
63        "lat": "40.673523811763259",
64        "lng": "-73.86335212657626",
65        "datetime": "2023-03-08T08:12:57Z"
66      },
67      {
68        "order_id": null,
69        "sequence": "4",
70        "type": "dropoff",
71        "name": null,
72        "formatted_address": "102 South E St, New York, NY 10002, US",
73        "lat": "40.689177462234504",
74        "lng": "-73.89453884284752",
75        "datetime": "2023-03-08T08:31:36Z"
76      }
77    ],
78    "orders": [
79      {
80        "order_id": "1",
81        "sequence": "1",
82        "income": {
83          "currency": "USD",
84          "total_charge": "34.75",
85          "customer_price": "26.38",
86          "fees": "8.37",
87          "total": "19.96",
88          "pay": "22.28",
89          "tips": null,
90          "bonus": "0.00",
91          "other": "-2.32"
92        }
93      },
94      {
95        "order_id": "2",
96        "sequence": "2",
97        "income": {
98          "currency": "USD",
99          "total_charge": "7.25",
100          "customer_price": "7.25",
101          "fees": null,
102          "total": "4.30",
103          "pay": "4.30",
104          "tips": "0.00",
105          "bonus": "0.00",
106          "other": null
107        }
108      }
109    ]
110  },
111  "distance": "1.80",
112  "distance_unit": "miles",
113  "metadata": {
114    "income.other": {
115      "name": "Taxes: Withholding tax",
116      "value": "-15.32"
117    }
118  },
119  "circumstances": {
120    "is_pool": false,
121    "is_rush": false,
122    "is_surge": true,
123    "service_type": "Comfort Ride",
124    "position": null
125  },
126  "income": {
127    "currency": "USD",
128    "total_charge": "42.00",
129    "customer_price": "33.68",
130    "fees": "8.37",
131    "total": "30.68",
132    "pay": "26.58",
133    "tips": "6.42",
134    "bonus": "0.00",
135    "other": "-2.32"
136  },
137  "income_rates": {
138    "hour": "92.70",
139    "mile": "20.20"
140  }
141}

#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": "delivery",
9  "task_count": 2,
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  "task_details": {
36    "events": [
37      {
38        "order_id": null,
39        "sequence": "1",
40        "type": "accept",
41        "name": null,
42        "formatted_address": "201 North W St, New York, NY 10014, US",
43        "lat": "40.65932120164202",
44        "lng": "-73.89453884284752",
45        "datetime": "2023-03-08T08:09:38Z"
46      },
47      {
48        "order_id": "1",
49        "sequence": "2",
50        "type": "pickup",
51        "name": "Healthy Snacks",
52        "formatted_address": "150 East N St, New York, NY 10014, US",
53        "lat": "40.673422892136178",
54        "lng": "-73.88931269893891",
55        "datetime": "2023-03-08T08:12:57Z"
56      },
57      {
58        "order_id": "2",
59        "sequence": "3",
60        "type": "pickup",
61        "name": "Gourmet Desserts",
62        "formatted_address": "182 East N St, New York, NY 10014, US",
63        "lat": "40.673523811763259",
64        "lng": "-73.86335212657626",
65        "datetime": "2023-03-08T08:12:57Z"
66      },
67      {
68        "order_id": null,
69        "sequence": "4",
70        "type": "dropoff",
71        "name": null,
72        "formatted_address": "102 South E St, New York, NY 10002, US",
73        "lat": "40.689177462234504",
74        "lng": "-73.89453884284752",
75        "datetime": "2023-03-08T08:31:36Z"
76      }
77    ],
78    "orders": [
79      {
80        "order_id": "1",
81        "sequence": "1",
82        "income": {
83          "currency": "USD",
84          "total_charge": "34.75",
85          "customer_price": "26.38",
86          "fees": "8.37",
87          "total": "19.96",
88          "pay": "22.28",
89          "tips": null,
90          "bonus": "0.00",
91          "other": "-2.32"
92        }
93      },
94      {
95        "order_id": "2",
96        "sequence": "2",
97        "income": {
98          "currency": "USD",
99          "total_charge": "7.25",
100          "customer_price": "7.25",
101          "fees": null,
102          "total": "4.30",
103          "pay": "4.30",
104          "tips": "0.00",
105          "bonus": "0.00",
106          "other": null
107        }
108      }
109    ]
110  },
111  "distance": "1.80",
112  "distance_unit": "miles",
113  "metadata": {
114    "income.other": {
115      "name": "Taxes: Withholding tax",
116      "value": "-15.32"
117    }
118  },
119  "circumstances": {
120    "is_pool": false,
121    "is_rush": false,
122    "is_surge": true,
123    "service_type": "Comfort Ride",
124    "position": null
125  },
126  "income": {
127    "currency": "USD",
128    "total_charge": "42.00",
129    "customer_price": "33.68",
130    "fees": "8.37",
131    "total": "30.68",
132    "pay": "26.58",
133    "tips": "6.42",
134    "bonus": "0.00",
135    "other": "-2.32"
136  },
137  "income_rates": {
138    "hour": "92.70",
139    "mile": "20.20"
140  }
141}

#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    "task_details": {
37      "events": [],
38      "orders": []
39    },
40    "distance": "24.93",
41    "distance_unit": "miles",
42    "metadata": {},
43    "circumstances": {
44      "is_pool": false,
45      "is_rush": false,
46      "is_surge": true,
47      "service_type": "GigAntic XL",
48      "position": null
49    },
50    "income": {
51      "currency": "USD",
52      "total_charge": "34.79",
53      "customer_price": "25.32",
54      "fees": "9.47",
55      "total": "25.32",
56      "pay": "25.32",
57      "tips": "0.00",
58      "bonus": "0.00",
59      "other": null
60    },
61    "income_rates": {
62      "hour": "13.62",
63      "mile": "0.60"
64    }
65  },
66  {
67    "id": "0187dbfa-6f5e-a33a-af26-7e12ff408fea",
68    "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
69    "employer": "GigAndGo",
70    "created_at": "2023-03-08T08:31:37.037Z",
71    "updated_at": "2023-03-08T08:31:37.037Z",
72    "status": "completed",
73    "type": "delivery",
74    "task_count": 2,
75    "start_datetime": "2023-03-08T08:08:57Z",
76    "end_datetime": "2023-03-08T08:31:36Z",
77    "all_datetimes": {
78      "request_at": "2023-03-08T08:08:57Z",
79      "accept_at": "2023-03-08T08:09:38Z",
80      "pickup_at": "2023-03-08T08:12:57Z",
81      "dropoff_at": "2023-03-08T08:31:36Z",
82      "cancel_at": null,
83      "shift_start": null,
84      "shift_end": null,
85      "breaks": []
86    },
87    "duration": 2659,
88    "timezone": "America/New_York",
89    "earning_type": "work",
90    "start_location": {
91      "lat": "40.65932120164202",
92      "lng": "-73.8526246331782",
93      "formatted_address": "201 North W St, New York, NY 10014, US"
94    },
95    "end_location": {
96      "lat": "40.689177462234504",
97      "lng": "-73.89453884284752",
98      "formatted_address": "102 South E St, New York, NY 10002, US"
99    },
100    "task_details": {
101      "events": [
102        {
103          "order_id": null,
104          "sequence": "1",
105          "type": "accept",
106          "name": null,
107          "formatted_address": "201 North W St, New York, NY 10014, US",
108          "lat": "40.65932120164202",
109          "lng": "-73.89453884284752",
110          "datetime": "2023-03-08T08:09:38Z"
111        },
112        {
113          "order_id": "1",
114          "sequence": "2",
115          "type": "pickup",
116          "name": "Healthy Snacks",
117          "formatted_address": "150 East N St, New York, NY 10014, US",
118          "lat": "40.673422892136178",
119          "lng": "-73.88931269893891",
120          "datetime": "2023-03-08T08:12:57Z"
121        },
122        {
123          "order_id": "2",
124          "sequence": "3",
125          "type": "pickup",
126          "name": "Gourmet Desserts",
127          "formatted_address": "182 East N St, New York, NY 10014, US",
128          "lat": "40.673523811763259",
129          "lng": "-73.86335212657626",
130          "datetime": "2023-03-08T08:12:57Z"
131        },
132        {
133          "order_id": null,
134          "sequence": "4",
135          "type": "dropoff",
136          "name": null,
137          "formatted_address": "102 South E St, New York, NY 10002, US",
138          "lat": "40.689177462234504",
139          "lng": "-73.89453884284752",
140          "datetime": "2023-03-08T08:31:36Z"
141        }
142      ],
143      "orders": [
144        {
145          "order_id": "1",
146          "sequence": "1",
147          "income": {
148            "currency": "USD",
149            "total_charge": "34.75",
150            "customer_price": "26.38",
151            "fees": "8.37",
152            "total": "19.96",
153            "pay": "22.28",
154            "tips": null,
155            "bonus": "0.00",
156            "other": "-2.32"
157          }
158        },
159        {
160          "order_id": "2",
161          "sequence": "2",
162          "income": {
163            "currency": "USD",
164            "total_charge": "7.25",
165            "customer_price": "7.25",
166            "fees": null,
167            "total": "4.30",
168            "pay": "4.30",
169            "tips": "0.00",
170            "bonus": "0.00",
171            "other": null
172          }
173        }
174      ]
175    },
176    "distance": "1.80",
177    "distance_unit": "miles",
178    "metadata": {
179      "income.other": {
180        "name": "Taxes: Withholding tax",
181        "value": "-15.32"
182      }
183    },
184    "circumstances": {
185      "is_pool": false,
186      "is_rush": false,
187      "is_surge": true,
188      "service_type": "Comfort Ride",
189      "position": null
190    },
191    "income": {
192      "currency": "USD",
193      "total_charge": "42.00",
194      "customer_price": "33.68",
195      "fees": "8.37",
196      "total": "30.68",
197      "pay": "26.58",
198      "tips": "6.42",
199      "bonus": "0.00",
200      "other": "-2.32"
201    },
202    "income_rates": {
203      "hour": "92.70",
204      "mile": "20.20"
205    }
206  }
207]
Updating Argyle status...
┬ę 2024 Argyle Systems Inc.argyle.com