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

Available options:

Body

namestringrequired

descriptionstringoptional

countryCodestringoptional

commerceCodestringoptional

monthlyQuotaintegeroptional

tagsobject[]optional

Responses

application/json

application/json

application/json

application/json

application/json

post

cURLJavaScriptPythonHTTP

curl -L \
  --request POST \
  --url 'https://apis.objectsgrid.com/organizationaccounts' \
  --header 'Authorization: Bearer JWT' \
  --header 'X-ObjectsGrid-AccessPoint: EU' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "countryCode": "text",
    "commerceCode": "text",
    "monthlyQuota": 1,
    "tags": [
      {
        "name": "text",
        "val": "text"
      }
    ]
  }'

201

400

401

427

500

201

{
  "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-04-11T03:51:02.435Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-04-11T03:51:02.435Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Successfully created the organization account

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

Available options:

Responses

application/json

application/json

application/json

application/json

application/json

application/json

get

cURLJavaScriptPythonHTTP

curl -L \
  --url 'https://apis.objectsgrid.com/organizationaccounts/{orgacctid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'X-ObjectsGrid-AccessPoint: EU'

200

400

401

404

427

500

200

{
  "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-04-11T03:51:02.435Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-04-11T03:51:02.435Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Successfully retrieved the organization account

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

Available options:

Body

idstringoptional

namestringrequired

descriptionstringoptional

countryCodestringoptional

commerceCodestringoptional

ownerIDstringoptional

accessPointstringoptional

monthlyQuotaintegeroptional

tagsobject[]optional

metaobjectoptional

Responses

application/json

application/json

application/json

application/json

application/json

application/json

put

cURLJavaScriptPythonHTTP

curl -L \
  --request PUT \
  --url 'https://apis.objectsgrid.com/organizationaccounts/{orgacctid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'X-ObjectsGrid-AccessPoint: EU' \
  --header 'Content-Type: application/json' \
  --data '{
    "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-04-11T03:51:02.435Z",
      "createdBy": "text",
      "lastUpdatedAt": "2025-04-11T03:51:02.435Z",
      "lastUpdatedBy": "text",
      "lastUpdateCorrelationID": "text"
    }
  }'

200

400

401

404

427

500

200

{
  "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-04-11T03:51:02.435Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-04-11T03:51:02.435Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Successfully updated the organization account

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

Available options:

Responses

application/json

application/json

application/json

application/json

application/json

delete

cURLJavaScriptPythonHTTP

curl -L \
  --request DELETE \
  --url 'https://apis.objectsgrid.com/organizationaccounts/{orgacctid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'X-ObjectsGrid-AccessPoint: EU'

200

400

401

404

427

500

200

No Content

Successfully deleted the organization account