Organizations REST API
Organizations REST API documentation and interactive testing.
For the OpenAPI Specification document use this link: https://apis.objectsgrid.com/organizations/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.
Implements https://schema.org/Organization
Convention for '@context' JSON-LD compliance, convert in the frontend
Convention for '@type' JSON-LD compliance, convert in the frontend
The Review's ID, generated
image URL
URL reference to itself
URL to a brand
ISO 3339 date time string or null, not empty string
ISO 3339 date time string or null, not empty string
logo URL
URLs to Organizations
URLs to Organizations
URL to Organization
URLs to Reviews
The Review's ID, generated
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.
Implements https://schema.org/Organization
Convention for '@context' JSON-LD compliance, convert in the frontend
Convention for '@type' JSON-LD compliance, convert in the frontend
The Review's ID, generated
image URL
URL reference to itself
URL to a brand
ISO 3339 date time string or null, not empty string
ISO 3339 date time string or null, not empty string
logo URL
URLs to Organizations
URLs to Organizations
URL to Organization
URLs to Reviews
The Review's ID, generated
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.
Implements https://schema.org/Organization
Convention for '@context' JSON-LD compliance, convert in the frontend
Convention for '@type' JSON-LD compliance, convert in the frontend
The Review's ID, generated
image URL
URL reference to itself
URL to a brand
ISO 3339 date time string or null, not empty string
ISO 3339 date time string or null, not empty string
logo URL
URLs to Organizations
URLs to Organizations
URL to Organization
URLs to Reviews
The Review's ID, generated
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?