Skip to main content
GET
/
v2
/
ratings
/
{id}
Retrieve a rating
curl --request GET \
  --url https://api-sandbox.argyle.com/v2/ratings/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": "0176a5bd-6ed4-1a21-8661-32bc3546e6de",
  "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
  "rating": "4.98",
  "acceptance_rate": "0.91",
  "ontime_rate": "0.94",
  "achievements": [
    {
      "count": 1,
      "label": "excellent_service",
      "points": null,
      "metadata": {},
      "badge_url": "www.partner.com/badgeinfo",
      "description": "Excellent Service"
    },
    {
      "count": 1,
      "label": "great_amenities",
      "points": null,
      "metadata": {},
      "badge_url": "www.partner.com/badgeinfo",
      "description": "Great Amenities"
    }
  ],
  "employer": "GigAndGo",
  "created_at": "2023-03-15T13:19:55.723Z",
  "updated_at": "2023-03-15T13:19:55.723Z",
  "metadata": {}
}

Authorizations

​
Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Path Parameters

​
id
string<uuid>
required

ID of the rating object to be retrieved.

Response

200 - application/json
​
id
string<uuid>

Unique ID of the rating object.

​
account
string<uuid>

ID of the account associated with the rating object.

​
rating
string

A normalized average of the user's ratings between 0 and 5. Overall average, as payroll system do not typically provide ratings information for individual events.

​
acceptance_rate
string

Percent of the time the user accepts a task. Decimal between 0 and 1.

​
ontime_rate
string

Percent of the time the user completes a task on time. Decimal between 0 and 1.

​
achievements
object[]

Individual ratings or achievement information, sorted into relevant key:value pairs. Varies by gig platform.

​
rewards
object[]

Rewards program information.

​
employer
string

Name of the user's employer.

​
created_at
string<datetime>

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

​
updated_at
string<datetime>

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

​
metadata
object

Additional, non-categorized information.