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": 1,
    "page_num": 2,
    "page_size": 2,
    "total_records": 1
  },
  "response": [
    {
      "address": {
        "city": "Bend",
        "state": "OR",
        "street_one": "339 Hickory Street",
        "zip_code": "97701",
        "county": "Deschutes",
        "street_two": "Apartment 5"
      },
      "created": 123,
      "display_name": "Primary Company Location",
      "group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "modified": 123,
      "version": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

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