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>'
{
  "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"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.noyo.com/llms.txt

Use this file to discover all available pages before exploring further.

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