Skip to main content
GET
/
v2
/
ratings
List all ratings
curl --request GET \
  --url https://api-sandbox.argyle.com/v2/ratings \
  --header 'Authorization: Basic <encoded-value>'
import requests

url = "https://api-sandbox.argyle.com/v2/ratings"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api-sandbox.argyle.com/v2/ratings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.argyle.com/v2/ratings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.argyle.com/v2/ratings"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api-sandbox.argyle.com/v2/ratings")
  .header("Authorization", "Basic <encoded-value>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.argyle.com/v2/ratings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body
{
  "next": "https://api-sandbox.argyle.com/v2/ratings?cursor=ZXhhbXBsZV9jdXJzb3I",
  "previous": null,
  "results": [
    {
      "id": "0186b4eb-1e33-bb38-a45a-1db105b5bed0",
      "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
      "rating": "4.14",
      "acceptance_rate": "0.87",
      "ontime_rate": "0.85",
      "achievements": [
        {
          "count": 3,
          "label": "excellent_service",
          "points": "300",
          "award": null,
          "description": "Excellent Service",
          "metadata": {}
        },
        {
          "count": 2,
          "label": "speed_demon",
          "points": "200",
          "award": "Speed Demon",
          "description": "Fast Service",
          "metadata": {}
        }
      ],
      "employer": "GigAntic",
      "created_at": "2023-03-15T11:15:20.359Z",
      "updated_at": "2023-03-15T11:15:20.359Z",
      "metadata": {}
    },
    {
      "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": 3,
          "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

Query Parameters

account
string<uuid>

Filter by account ID.

user
string<uuid>

Filter by user ID.

limit
integer

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

cursor
string

The URL returned in next or previous used to retrieve another page of results.

Response

200 - application/json
next
string<uri> | null

URL for the next page of results, if available.

previous
string<uri> | null

URL for the previous page of results, if available.

results
object[]