ObjectsGrid
  • Documentation
    • Core Concepts
    • Usage Guide
      • Quick Start
      • Authentication and Authorization
      • Access Control via ABAC
      • GraphQL API Examples
      • Login with Google app setup
      • Objects Schemas
    • OBJECTS GRID Objects
      • Generic Object
        • GenericObjects REST API
      • Enum Object
        • Enum Object REST API
      • ProductCatalog Object
      • ProductGroup Object
      • Product Object
      • Brand Object
        • Brands REST API
      • Language-Tagged String
      • Tags Object
      • Meta Object
    • Private Objects
      • Auth
        • Tokens REST API
      • ABAC Policy
        • ABACPolicies REST API
      • Organization Account
        • OrganizationAccounts REST API
      • User Account
        • UserAccounts REST API
      • Service Account
        • ServiceAccounts REST API
      • Access Logging
        • AccessLogEntries REST API
  • Support
    • Terms and Conditions
  • Blogs
    • Attribute Based Access Control
    • ABAC vs RBAC
Powered by GitBook
On this page

Was this helpful?

  1. Documentation
  2. OBJECTS GRID Objects
  3. Brand Object

Brands REST API

Brands REST API documentation and interactive testing.

PreviousBrand ObjectNextLanguage-Tagged String

Last updated 19 hours ago

Was this helpful?

For the document use this link:

OpenAPI Specification
https://apis.objectsgrid.com/brands/contract

Delete Object

delete
Authorizations
Path parameters
idstringRequired

ID of the object to delete

Header parameters
X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:
X-ObjectsGrid-RestApiVersionstringOptional

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'

X-ObjectsGrid-SessionIDstringOptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Responses
200
Successfully deleted the object
400
Bad request
application/json
401
Unauthorized
application/json
404
Not Found
application/json
427
Too Many Requests
application/json
500
Internal server error
application/json
delete
DELETE /brands/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Accept: */*

No content

List objects

get

This operation supports Elastic Search Query DSL query format

Authorizations
Query parameters
langstringOptional

BCP 47 language code

Example: fr, de, de-AT, cy-GB
querystringOptional

Elastic Search Query DSL for querying service Accounts.

Example: { "query": { "match_all": {} } }
fromintegerOptional

Defines the starting record number for retrieval.

sizeintegerOptional

Defines the number of records to retrieve.

Header parameters
X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:
X-ObjectsGrid-RestApiVersionstringOptional

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'

X-ObjectsGrid-SessionIDstringOptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Responses
200
Successfully listed the objects
application/json
400
Bad request
application/json
401
Unauthorized
application/json
427
Too Many Requests - rate limited
application/json
500
Internal Server Error
application/json
get
GET /brands HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Accept: */*

[
  {
    "at_context": "https://schema.org",
    "at_type": "Brand",
    "id": "text",
    "identifier": "text",
    "name": [
      {
        "at_value": "text",
        "at_language": "text"
      }
    ],
    "description": [
      {
        "at_value": "text",
        "at_language": "text"
      }
    ],
    "slogan": [
      {
        "at_value": "text",
        "at_language": "text"
      }
    ],
    "sameAs": [
      "text"
    ],
    "url": "text",
    "logo": "text",
    "tags": [
      {
        "name": "text",
        "val": "text"
      }
    ],
    "meta": {
      "objectVersion": 1,
      "objectType": "text",
      "namespace": "text",
      "createdAt": "2025-05-28T23:31:29.674Z",
      "createdBy": "text",
      "lastUpdatedAt": "2025-05-28T23:31:29.674Z",
      "lastUpdatedBy": "text",
      "lastUpdateCorrelationID": "text"
    }
  }
]
  • POSTCreate object
  • GETRetrieve Object
  • PUTUpdate Object
  • PATCHPatch Object
  • DELETEDelete Object
  • GETList objects

Retrieve Object

get
Authorizations
Path parameters
idstringRequired

ID of the object to retrieve

Query parameters
langstringOptional

BCP 47 language code

Example: fr, de, de-AT, cy-GB
Header parameters
X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:
X-ObjectsGrid-RestApiVersionstringOptional

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'

X-ObjectsGrid-SessionIDstringOptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Responses
200
Successfully retrieved the object
application/json
400
Bad request
application/json
401
Unauthorized
application/json
404
Not Found
application/json
427
Too Many Requests
application/json
500
Internal server error
application/json
get
GET /brands/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Accept: */*

{
  "at_context": "https://schema.org",
  "at_type": "Brand",
  "id": "text",
  "identifier": "text",
  "name": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "description": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "slogan": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "sameAs": [
    "text"
  ],
  "url": "text",
  "logo": "text",
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-05-28T23:31:29.674Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-05-28T23:31:29.674Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Create object

post
Authorizations
Header parameters
X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:
X-ObjectsGrid-RestApiVersionstringOptional

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'

X-ObjectsGrid-SessionIDstringOptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Body
at_contextstring · enumOptional

Convention for '@context' JSON-LD compliance, convert in the frontend

Possible values:
at_typestring · enumOptional

Convention for '@type' JSON-LD compliance, convert in the frontend

Possible values:
idstringOptional

The Brand's ID, generated

identifierstringOptional
sameAsstring[]Optional
urlstringOptional
logostringOptional
Responses
201
Successfully created the object
application/json
400
Bad request
application/json
401
Unauthorized
application/json
409
Conflict, object already exists
application/json
427
Too Many Requests - rate limited
application/json
500
Internal Server Error
application/json
post
POST /brands HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Content-Type: application/json
Accept: */*
Content-Length: 550

{
  "at_context": "https://schema.org",
  "at_type": "Brand",
  "id": "text",
  "identifier": "text",
  "name": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "description": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "slogan": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "sameAs": [
    "text"
  ],
  "url": "text",
  "logo": "text",
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-05-28T23:31:29.674Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-05-28T23:31:29.674Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}
{
  "at_context": "https://schema.org",
  "at_type": "Brand",
  "id": "text",
  "identifier": "text",
  "name": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "description": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "slogan": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "sameAs": [
    "text"
  ],
  "url": "text",
  "logo": "text",
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-05-28T23:31:29.674Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-05-28T23:31:29.674Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Update Object

put
Authorizations
Path parameters
idstringRequired

ID of the object to update

Header parameters
X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:
X-ObjectsGrid-RestApiVersionstringOptional

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'

X-ObjectsGrid-SessionIDstringOptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Body
at_contextstring · enumOptional

Convention for '@context' JSON-LD compliance, convert in the frontend

Possible values:
at_typestring · enumOptional

Convention for '@type' JSON-LD compliance, convert in the frontend

Possible values:
idstringOptional

The Brand's ID, generated

identifierstringOptional
sameAsstring[]Optional
urlstringOptional
logostringOptional
Responses
200
Successfully updated the object
application/json
400
Bad request
application/json
401
Unauthorized
application/json
404
Not Found
application/json
427
Too Many Requests
application/json
500
Internal server error
application/json
put
PUT /brands/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Content-Type: application/json
Accept: */*
Content-Length: 550

{
  "at_context": "https://schema.org",
  "at_type": "Brand",
  "id": "text",
  "identifier": "text",
  "name": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "description": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "slogan": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "sameAs": [
    "text"
  ],
  "url": "text",
  "logo": "text",
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-05-28T23:31:29.674Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-05-28T23:31:29.674Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}
{
  "at_context": "https://schema.org",
  "at_type": "Brand",
  "id": "text",
  "identifier": "text",
  "name": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "description": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "slogan": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "sameAs": [
    "text"
  ],
  "url": "text",
  "logo": "text",
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-05-28T23:31:29.674Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-05-28T23:31:29.674Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Patch Object

patch
Authorizations
Path parameters
idstringRequired

ID of the object to update

Header parameters
X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:
X-ObjectsGrid-RestApiVersionstringOptional

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'

X-ObjectsGrid-SessionIDstringOptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Body
at_contextstring · enumOptional

Convention for '@context' JSON-LD compliance, convert in the frontend

Possible values:
at_typestring · enumOptional

Convention for '@type' JSON-LD compliance, convert in the frontend

Possible values:
idstringOptional

The Brand's ID, generated

identifierstringOptional
sameAsstring[]Optional
urlstringOptional
logostringOptional
Responses
200
Successfully patched the object
application/json
400
Bad request
application/json
401
Unauthorized
application/json
404
Not Found
application/json
427
Too Many Requests
application/json
500
Internal server error
application/json
patch
PATCH /brands/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Content-Type: application/json
Accept: */*
Content-Length: 550

{
  "at_context": "https://schema.org",
  "at_type": "Brand",
  "id": "text",
  "identifier": "text",
  "name": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "description": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "slogan": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "sameAs": [
    "text"
  ],
  "url": "text",
  "logo": "text",
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-05-28T23:31:29.674Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-05-28T23:31:29.674Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}
{
  "at_context": "https://schema.org",
  "at_type": "Brand",
  "id": "text",
  "identifier": "text",
  "name": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "description": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "slogan": [
    {
      "at_value": "text",
      "at_language": "text"
    }
  ],
  "sameAs": [
    "text"
  ],
  "url": "text",
  "logo": "text",
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-05-28T23:31:29.674Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-05-28T23:31:29.674Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}