Locations

List Locations

get

Retrieve every active location on the project for slug references or reconciliation with upstream systems.

Authorizations

ApiKey

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Short code or application-level status code for this resource.

get

/locations

HTTPcURLJavaScriptPython

GET /project/locations HTTP/1.1
Host: api.moregoodreviews.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Success

{
  "success": true,
  "code": 200,
  "data": [
    {
      "id": 12,
      "project_id": 42,
      "uuid": "51987517-6a48-4e4d-87d5-934147e46234",
      "name": "Downtown",
      "display_name": "Acme Dental Downtown Office",
      "slug": "downtown",
      "store_code": "CHI-DTN",
      "title": "Downtown Office",
      "address": "123 Main St, Chicago, IL 60601",
      "address1": "123 Main St",
      "address2": "Suite 400",
      "city": "Chicago",
      "state": "IL",
      "postal_code": "60601"
    },
    {
      "id": 13,
      "project_id": 42,
      "uuid": "62998628-7b59-5f5f-98e6-a45258f57345",
      "name": "Northside",
      "display_name": "Acme Dental Northside",
      "slug": "northside",
      "store_code": "CHI-NTH",
      "title": "Northside Office",
      "address": "400 Clark St, Chicago, IL 60640",
      "address1": "400 Clark St",
      "address2": null,
      "city": "Chicago",
      "state": "IL",
      "postal_code": "60640"
    }
  ]
}

Create Location

post

Create a physical or business location for the project.

Authorizations

ApiKey

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Object containing response data for this resource.

namestringRequired

Display name for this resource.

display_namestringOptional

Public display name for this resource.

slugstringOptional

URL-friendly identifier for this resource.

store_codestringOptional

Internal store identifier for this location.

address1stringOptional

Primary street address line.

address2stringOptional

Secondary street address line, such as suite or apartment.

citystringOptional

City for the address.

statestringOptional

State, province, or region for the address.

postal_codestringOptional

Postal or ZIP code for the address.

Responses

200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Short code or application-level status code for this resource.

post

/locations

HTTPcURLJavaScriptPython

POST /project/locations HTTP/1.1
Host: api.moregoodreviews.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 198

{
  "name": "Downtown",
  "display_name": "Acme Dental Downtown",
  "slug": "downtown",
  "store_code": "CHI-DTN",
  "address1": "123 Main St",
  "address2": "Suite 400",
  "city": "Chicago",
  "state": "IL",
  "postal_code": "60601"
}

200

Success

{
  "success": true,
  "code": 200,
  "data": {
    "id": 12,
    "project_id": 42,
    "uuid": "51987517-6a48-4e4d-87d5-934147e46234",
    "name": "Downtown",
    "display_name": "Acme Dental Downtown",
    "slug": "downtown",
    "store_code": "CHI-DTN",
    "title": "Downtown Office",
    "address": "123 Main St, Chicago, IL 60601",
    "address1": "123 Main St",
    "address2": "Suite 400",
    "city": "Chicago",
    "state": "IL",
    "postal_code": "60601"
  }
}

Get Location

get

Retrieve a single project location for display slug or reconciliation use.

Authorizations

ApiKey

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idintegerRequired

Unique numeric identifier for this resource.

Responses

200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Application-level status code returned by More Good Reviews.

dataobjectOptional

Location record for this project.

get

/locations/{id}

HTTPcURLJavaScriptPython

GET /project/locations/{id} HTTP/1.1
Host: api.moregoodreviews.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Success

{
  "success": true,
  "code": 200,
  "data": {
    "id": 12,
    "project_id": 42,
    "uuid": "51987517-6a48-4e4d-87d5-934147e46234",
    "name": "Downtown",
    "display_name": "Acme Dental Downtown Office",
    "slug": "downtown",
    "store_code": "CHI-DTN",
    "title": "Downtown Office",
    "address": "123 Main St, Chicago, IL 60601",
    "address1": "123 Main St",
    "address2": "Suite 400",
    "city": "Chicago",
    "state": "IL",
    "postal_code": "60601"
  }
}

Update Location

put

Update public display and address details for a project location.

Authorizations

ApiKey

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idintegerRequired

Unique numeric identifier for this resource.

Body

application/json

Object containing response data for this resource.

namestringOptional

Display name for this resource.

display_namestringOptional

Public display name for this resource.

slugstringOptional

URL-friendly identifier for this resource.

store_codestringOptional

Internal store identifier for this location.

address1stringOptional

Primary street address line.

address2stringOptional

Secondary street address line, such as suite or apartment.

citystringOptional

City for the address.

statestringOptional

State, province, or region for the address.

postal_codestringOptional

Postal or ZIP code for the address.

Responses

200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Short code or application-level status code for this resource.

put

/locations/{id}

HTTPcURLJavaScriptPython

PUT /project/locations/{id} HTTP/1.1
Host: api.moregoodreviews.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 205

{
  "name": "Downtown",
  "display_name": "Acme Dental Downtown Office",
  "slug": "downtown",
  "store_code": "CHI-DTN",
  "address1": "123 Main St",
  "address2": "Suite 400",
  "city": "Chicago",
  "state": "IL",
  "postal_code": "60601"
}

200

Success

{
  "success": true,
  "code": 200,
  "data": {
    "id": 12,
    "project_id": 42,
    "uuid": "51987517-6a48-4e4d-87d5-934147e46234",
    "name": "Downtown",
    "display_name": "Acme Dental Downtown Office",
    "slug": "downtown",
    "store_code": "CHI-DTN",
    "title": "Downtown Office",
    "address": "123 Main St, Chicago, IL 60601",
    "address1": "123 Main St",
    "address2": "Suite 400",
    "city": "Chicago",
    "state": "IL",
    "postal_code": "60601"
  }
}

Delete Location

delete

Remove a project location owned by the authenticated project.

Authorizations

ApiKey

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idintegerRequired

Unique numeric identifier for this resource.

Responses

200

Success

application/json

Confirms the location was deleted.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Application-level status code returned by More Good Reviews.

delete

/locations/{id}

HTTPcURLJavaScriptPython

DELETE /project/locations/{id} HTTP/1.1
Host: api.moregoodreviews.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Success

{
  "success": true,
  "code": 200
}