OrganizationAccounts REST API

Organization Accounts REST API documentation and interactive testing.

For the OpenAPI Specification document use this link: https://apis.objectsgrid.com/organizationaccounts/contract

To get a Google JWT ID Token you can use our test app for now: https://admin.objectsgrid.com/google_token.html You'll need it in the Authorizations header in the Create Organization Account request below.

Create a new organization account

post
Authorizations
Header parameters
X-ObjectsGrid-AccessPointstring · enumRequired

EU for European Union, or US for United States, depending on where you need to locate your data

Possible values:
Body
namestringRequired
descriptionstringOptional
countryCodestringOptional
commerceCodestringOptional
monthlyQuotaintegerOptional
Responses
201
Successfully created the organization account
application/json
post
POST /organizationaccounts HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Content-Type: application/json
Accept: */*
Content-Length: 134

{
  "name": "text",
  "description": "text",
  "countryCode": "text",
  "commerceCode": "text",
  "monthlyQuota": 1,
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ]
}
{
  "id": "text",
  "name": "text",
  "description": "text",
  "countryCode": "text",
  "commerceCode": "text",
  "ownerID": "text",
  "accessPoint": "text",
  "monthlyQuota": 1,
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-07-11T01:35:11.054Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-07-11T01:35:11.054Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Get an organization account

get
Authorizations
Path parameters
orgacctidstringRequired

ID of the organization account to retrieve

Header parameters
X-ObjectsGrid-AccessPointstring · enumRequired

EU for European Union, or US for United States, depending on where your data is located

Possible values:
Responses
200
Successfully retrieved the organization account
application/json
get
GET /organizationaccounts/{orgacctid} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Accept: */*

{
  "id": "text",
  "name": "text",
  "description": "text",
  "countryCode": "text",
  "commerceCode": "text",
  "ownerID": "text",
  "accessPoint": "text",
  "monthlyQuota": 1,
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-07-11T01:35:11.054Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-07-11T01:35:11.054Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Update an organization account

put
Authorizations
Path parameters
orgacctidstringRequired

ID of the organization account to update

Header parameters
X-ObjectsGrid-AccessPointstring · enumRequired

EU for European Union, or US for United States, depending on where your data is located

Possible values:
Body
idstringOptional
namestringRequired
descriptionstringOptional
countryCodestringOptional
commerceCodestringOptional
ownerIDstringOptional
accessPointstringOptional
monthlyQuotaintegerOptional
Responses
200
Successfully updated the organization account
application/json
put
PUT /organizationaccounts/{orgacctid} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Content-Type: application/json
Accept: */*
Content-Length: 407

{
  "id": "text",
  "name": "text",
  "description": "text",
  "countryCode": "text",
  "commerceCode": "text",
  "ownerID": "text",
  "accessPoint": "text",
  "monthlyQuota": 1,
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-07-11T01:35:11.054Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-07-11T01:35:11.054Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}
{
  "id": "text",
  "name": "text",
  "description": "text",
  "countryCode": "text",
  "commerceCode": "text",
  "ownerID": "text",
  "accessPoint": "text",
  "monthlyQuota": 1,
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-07-11T01:35:11.054Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-07-11T01:35:11.054Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Delete an organization account

delete
Authorizations
Path parameters
orgacctidstringRequired

ID of the organization account to delete

Header parameters
X-ObjectsGrid-AccessPointstring · enumRequired

EU for European Union, or US for United States, depending on where your data is located

Possible values:
Responses
200
Successfully deleted the organization account
delete
DELETE /organizationaccounts/{orgacctid} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Accept: */*

No content
PreviousOrganization AccountNextUser Account

Last updated

Was this helpful?