Skip to main content
GET
/
api
/
v1
/
groups
/
{group_id}
/
locations
Get a list of all Group Locations
curl --request GET \
  --url https://fulfillment.noyo.com/api/v1/groups/{group_id}/locations \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://fulfillment.noyo.com/api/v1/groups/{group_id}/locations"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://fulfillment.noyo.com/api/v1/groups/{group_id}/locations', 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://fulfillment.noyo.com/api/v1/groups/{group_id}/locations",
  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: Bearer <token>"
  ],
]);

$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://fulfillment.noyo.com/api/v1/groups/{group_id}/locations"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://fulfillment.noyo.com/api/v1/groups/{group_id}/locations")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://fulfillment.noyo.com/api/v1/groups/{group_id}/locations")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "meta": {
    "offset": 0,
    "page_num": 1,
    "page_size": 20,
    "total_records": 2
  },
  "response": [
    {
      "address": {
        "city": "San Francisco",
        "county": "San Francisco",
        "state": "CA",
        "street_one": "1234 Test Ln",
        "zip_code": "94107"
      },
      "created": 1557512389,
      "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
      "id": "bd957820-4652-4ee7-8a3a-6413df21e28d",
      "modified": 1543215342,
      "version": "f4142cba-f3eb-4917-b3bd-123d683f18d7"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

group_id
string<uuid>
required

The unique identifier of the group for which you would like to view locations

Example:

"2613a221-d3c8-4c8a-86d5-e7e885fd1da9"

Query Parameters

page_size
integer

The max size of each page of results

offset
integer

The integer offset at which to start the page. Possible values are 0 to total_records - 1

Response

200 - application/json

Successful Response - Returns all matching Group Locations

meta
object
required

Metadata associated with the response data

response
object[]
required

List of location results