Skip to content
KynectLocal Docs

Get map pins for all active locations

GET
/public/brands/{brandId}/locations/map-pins
 
curl --request GET \
  --url https://kynectlocal-production.up.railway.app/v1/public/brands/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/locations/map-pins

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
brandId
required
string format: uuid

Brand identifier

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success

Media type application/json
object
data
required
object
pins
required
Array<object>
object
locationId
required

Location identifier

string format: uuid
name
required

Location display name

string
lat
required

Latitude

number | null
lng
required

Longitude

number | null
address
required

Street address

string | null
city
required

City

string | null
state
required

State/province code

string | null
slug
required

Location slug

string
Example generated
{
  "data": {
    "pins": [
      {
        "locationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "name": "example",
        "lat": 1,
        "lng": 1,
        "address": "example",
        "city": "example",
        "state": "example",
        "slug": "example"
      }
    ]
  }
}

400

Section titled “400 ”

Validation error

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

401

Section titled “401 ”

Unauthenticated

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

403

Section titled “403 ”

Forbidden

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

404

Section titled “404 ”

Not found

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

422

Section titled “422 ”

Unprocessable

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}