Places REST API
Places REST API documentation and interactive testing.
For the OpenAPI Specification document use this link: https://apis.objectsgrid.com/places/contract
JWT Access Token obtained from Create User Account Access Token operation.
EU or US depending on where your Organization Account is located
This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'
This header allows you to provide a Session ID to be traced through the request stack and returned in the response.
Objects Grid Place Object
The unique identifier
Schema context
The object type
The unique identifier
image URL
URL of a reference Web page that unambiguously indicates the item's identity
This Object URL
A short textual code (also called 'store code') that uniquely identifies a place of business.
The larger place that contains this place.
The place that contains this place.
Upcoming or past events associated with this place or organization.
The fax number.
The Global Location Number (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place.
Indicates whether the place has a drive-through service.
Indicates whether the place has a GS1 Digital Link.
A URL to a map of the place.
Indicates whether the place is accessible for free.
The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
Keywords or tags used to describe this place.
The latitude of the place.
A logo associated with the place.
The longitude of the place.
The total number of individuals that may attend an event or venue.
Indicates whether the place is open to public visitors.
Reviews of the item.
Indicates whether smoking is allowed.
The telephone number.
A page providing information about how to book a tour of some place.
Successfully created the object
Bad request
Unauthorized
Conflict, object already exists
Too Many Requests - rate limited
Internal Server Error
JWT Access Token obtained from Create User Account Access Token operation.
ID of the object to retrieve
BCP 47 language code
fr, de, de-AT, cy-GBEU or US depending on where your Organization Account is located
This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'
This header allows you to provide a Session ID to be traced through the request stack and returned in the response.
Successfully retrieved the object
Bad request
Unauthorized
Not Found
Too Many Requests
Internal server error
JWT Access Token obtained from Create User Account Access Token operation.
ID of the object to update
EU or US depending on where your Organization Account is located
This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'
This header allows you to provide a Session ID to be traced through the request stack and returned in the response.
Objects Grid Place Object
The unique identifier
Schema context
The object type
The unique identifier
image URL
URL of a reference Web page that unambiguously indicates the item's identity
This Object URL
A short textual code (also called 'store code') that uniquely identifies a place of business.
The larger place that contains this place.
The place that contains this place.
Upcoming or past events associated with this place or organization.
The fax number.
The Global Location Number (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place.
Indicates whether the place has a drive-through service.
Indicates whether the place has a GS1 Digital Link.
A URL to a map of the place.
Indicates whether the place is accessible for free.
The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
Keywords or tags used to describe this place.
The latitude of the place.
A logo associated with the place.
The longitude of the place.
The total number of individuals that may attend an event or venue.
Indicates whether the place is open to public visitors.
Reviews of the item.
Indicates whether smoking is allowed.
The telephone number.
A page providing information about how to book a tour of some place.
Successfully updated the object
Bad request
Unauthorized
Not Found
Too Many Requests
Internal server error
JWT Access Token obtained from Create User Account Access Token operation.
ID of the object to update
EU or US depending on where your Organization Account is located
This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'
This header allows you to provide a Session ID to be traced through the request stack and returned in the response.
Objects Grid Place Object
The unique identifier
Schema context
The object type
The unique identifier
image URL
URL of a reference Web page that unambiguously indicates the item's identity
This Object URL
A short textual code (also called 'store code') that uniquely identifies a place of business.
The larger place that contains this place.
The place that contains this place.
Upcoming or past events associated with this place or organization.
The fax number.
The Global Location Number (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place.
Indicates whether the place has a drive-through service.
Indicates whether the place has a GS1 Digital Link.
A URL to a map of the place.
Indicates whether the place is accessible for free.
The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
Keywords or tags used to describe this place.
The latitude of the place.
A logo associated with the place.
The longitude of the place.
The total number of individuals that may attend an event or venue.
Indicates whether the place is open to public visitors.
Reviews of the item.
Indicates whether smoking is allowed.
The telephone number.
A page providing information about how to book a tour of some place.
Successfully patched the object
Bad request
Unauthorized
Not Found
Too Many Requests
Internal server error
JWT Access Token obtained from Create User Account Access Token operation.
ID of the object to delete
EU or US depending on where your Organization Account is located
This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'
This header allows you to provide a Session ID to be traced through the request stack and returned in the response.
Successfully deleted the object
Bad request
Unauthorized
Not Found
Too Many Requests
Internal server error
No content
This operation supports Elastic Search Query DSL query format
JWT Access Token obtained from Create User Account Access Token operation.
BCP 47 language code
fr, de, de-AT, cy-GBElastic Search Query DSL.
{ "query": { "match_all": {} } }Defines the starting record number for retrieval.
Defines the number of records to retrieve.
EU or US depending on where your Organization Account is located
This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'
This header allows you to provide a Session ID to be traced through the request stack and returned in the response.
Successfully listed the objects
Bad request
Unauthorized
Too Many Requests - rate limited
Internal Server Error
Last updated
Was this helpful?