Skip to main content
GET
Get Location By Id

Authorizations

Authorization
string
header
required

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

Headers

x-connector-token
string
required

Path Parameters

id
string<uuid>
required

Query Parameters

include_raw_data
boolean
default:false

Whether to include the original data Bindbee fetched from the third-party to produce these models.

Example:

false

include_custom_fields
boolean
default:false

Whether to include custom fields in the response.

Example:

false

Response

Successful Response

id
string<uuid>
required
Example:

"018b18ef-c487-703c-afd9-0ca478ccd9d6"

remote_id
string | null
required

The third-party API ID of the matching object.

Example:

"123321"

modified_at
string<date-time>
required

This is the datetime that this object was last updated by Bindbee

Example:

"2021-10-16T00:00:00Z"

custom_fields
Custom Fields · object | null
required

The custom fields related to the model

Example:
raw_data
Raw Data · object | null

This is the Raw data

Example:
name
string | null

Name of the location

Example:

"UK-HO-London"

street_1
string | null

Street 1

Example:

"1011"

street_2
string | null

Street 2

Example:

"Lane number 4, Golden Villa"

city
string | null

City

Example:

"London"

state
string | null

State

Example:

"LND"

postal_code
string | null

Postal Code

Example:

"56273"

country
string | null

Country

Example:

"UK"