---
title: Get All Objects
slug: get-all-objects
createdAt: 2026-08-25T19:28:59.170Z
---

{
  "id": "MBDF4ec8YoYmZVxrI74A5",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "https://api.nue.io/metadata/objects",
    "servers": [
      {
        "url": "https://api.nue.io/metadata/objects",
        "description": "Nue Production API Endpoint"
      },
      {
        "url": "https://api.sandbox.nue.io/metadata/objects",
        "description": "Nue Sandbox API Endpoint"
      }
    ],
    "name": "Get All Objects",
    "description": "<p>Retrieve metadata definitions for all available objects, including their properties, standard fields, and custom fields. This provides a comprehensive view of all business objects in the system.</p>",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [
        {
          "name": "accept",
          "type": "string",
          "kind": "optional",
          "description": "Generated from available response content types",
          "enum": [
            "application/json"
          ],
          "default": "application/json"
        }
      ],
      "queryParameters": [],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "apiKeyAuth",
          "name": "nue-api-key",
          "kind": "optional",
          "type": "apiKey",
          "in": "header"
        }
      ],
      "cookieParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "OK",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "array",
            "description": "",
            "customType": "DescribeRubyObjectResponse[]",
            "schema": [
              {
                "name": "apiName",
                "kind": "optional",
                "type": "string",
                "description": "",
                "example": "Order"
              },
              {
                "name": "name",
                "kind": "optional",
                "type": "string",
                "description": "",
                "example": "Order"
              },
              {
                "name": "description",
                "kind": "optional",
                "type": "string",
                "description": "",
                "example": "Represents a booking transaction between a company and a customer to provision services or deliver products with contracted quantities, prices, and terms."
              },
              {
                "name": "salesforceApiName",
                "kind": "optional",
                "type": "string",
                "description": "",
                "example": "Order"
              },
              {
                "name": "endpoint",
                "kind": "optional",
                "type": "string",
                "description": "",
                "example": "/metadata/objects/Order"
              },
              {
                "name": "customizable",
                "kind": "optional",
                "type": "boolean",
                "description": "",
                "example": true
              },
              {
                "name": "feature",
                "kind": "optional",
                "type": "string",
                "description": "",
                "example": "OrderManagement"
              },
              {
                "name": "objectType",
                "kind": "optional",
                "type": "string",
                "description": "",
                "example": "Entity"
              },
              {
                "name": "pluralName",
                "kind": "optional",
                "type": "string",
                "description": "",
                "example": "Orders"
              },
              {
                "name": "nameField",
                "kind": "optional",
                "type": "string",
                "description": ""
              },
              {
                "name": "fields",
                "kind": "optional",
                "type": "array",
                "description": "",
                "modelRef": "#/components/schemas/FieldMetadata",
                "customType": "FieldMetadata[]",
                "schema": [
                  {
                    "name": "apiName",
                    "kind": "optional",
                    "type": "string",
                    "description": "",
                    "example": "Ruby__Trial__c"
                  },
                  {
                    "name": "name",
                    "kind": "optional",
                    "type": "string",
                    "description": "",
                    "example": "Trial"
                  },
                  {
                    "name": "type",
                    "kind": "optional",
                    "type": "string",
                    "description": "<p>Field type such as text, number, pickList, boolean, etc.</p>",
                    "example": "pickList"
                  },
                  {
                    "name": "description",
                    "kind": "optional",
                    "type": "string",
                    "description": "",
                    "example": "Indicates whether this order is a trial order"
                  },
                  {
                    "name": "creatable",
                    "kind": "optional",
                    "type": "boolean",
                    "description": "",
                    "example": true
                  },
                  {
                    "name": "updatable",
                    "kind": "optional",
                    "type": "boolean",
                    "description": "",
                    "example": true
                  },
                  {
                    "name": "filterable",
                    "kind": "optional",
                    "type": "boolean",
                    "description": "",
                    "example": true
                  },
                  {
                    "name": "sortable",
                    "kind": "optional",
                    "type": "boolean",
                    "description": "",
                    "example": true
                  },
                  {
                    "name": "customField",
                    "kind": "optional",
                    "type": "boolean",
                    "description": "<p>True if this is a custom field, false for standard fields</p>",
                    "example": true
                  },
                  {
                    "name": "encrypted",
                    "kind": "optional",
                    "type": "boolean",
                    "description": ""
                  },
                  {
                    "name": "defaultValue",
                    "kind": "optional",
                    "type": "string",
                    "description": ""
                  },
                  {
                    "name": "inlineHelpText",
                    "kind": "optional",
                    "type": "string",
                    "description": ""
                  },
                  {
                    "name": "required",
                    "kind": "optional",
                    "type": "boolean",
                    "description": ""
                  },
                  {
                    "name": "unique",
                    "kind": "optional",
                    "type": "boolean",
                    "description": ""
                  },
                  {
                    "name": "exportId",
                    "kind": "optional",
                    "type": "boolean",
                    "description": ""
                  },
                  {
                    "name": "minLength",
                    "kind": "optional",
                    "type": "integer<int32>",
                    "description": "",
                    "format": "int32"
                  },
                  {
                    "name": "maxLength",
                    "kind": "optional",
                    "type": "integer<int32>",
                    "description": "",
                    "format": "int32"
                  },
                  {
                    "name": "valueSet",
                    "kind": "optional",
                    "type": "object",
                    "description": "",
                    "modelRef": "#/components/schemas/ValueSet",
                    "customType": "ValueSet",
                    "schema": [
                      {
                        "name": "apiName",
                        "kind": "optional",
                        "type": "string",
                        "description": ""
                      },
                      {
                        "name": "name",
                        "kind": "optional",
                        "type": "string",
                        "description": ""
                      },
                      {
                        "name": "defaultValue",
                        "kind": "optional",
                        "type": "string",
                        "description": ""
                      },
                      {
                        "name": "alphabeticallyOrdered",
                        "kind": "optional",
                        "type": "boolean",
                        "description": ""
                      },
                      {
                        "name": "valuePairs",
                        "kind": "optional",
                        "type": "array",
                        "description": "",
                        "modelRef": "#/components/schemas/ValuePair",
                        "customType": "ValuePair[]",
                        "schema": [
                          {
                            "name": "apiName",
                            "kind": "optional",
                            "type": "string",
                            "description": "The API name of the value",
                            "example": "High"
                          },
                          {
                            "name": "name",
                            "kind": "optional",
                            "type": "string",
                            "description": "The display name of the value",
                            "example": "High Priority"
                          },
                          {
                            "name": "orderNumber",
                            "kind": "optional",
                            "type": "integer<int32>",
                            "description": "The sort order of this value in the list",
                            "example": 1,
                            "format": "int32"
                          },
                          {
                            "name": "active",
                            "kind": "optional",
                            "type": "boolean",
                            "description": "Whether this value is active and selectable",
                            "example": true
                          }
                        ]
                      }
                    ]
                  },
                  {
                    "name": "precision",
                    "kind": "optional",
                    "type": "integer<int32>",
                    "description": "",
                    "format": "int32"
                  },
                  {
                    "name": "scale",
                    "kind": "optional",
                    "type": "integer<int32>",
                    "description": "",
                    "format": "int32"
                  },
                  {
                    "name": "salesforceApiName",
                    "kind": "optional",
                    "type": "string",
                    "description": ""
                  },
                  {
                    "name": "lookupRelation",
                    "kind": "optional",
                    "type": "object",
                    "description": "",
                    "modelRef": "#/components/schemas/LookupRelation",
                    "customType": "LookupRelation",
                    "schema": [
                      {
                        "name": "referenceTo",
                        "kind": "optional",
                        "type": "string",
                        "description": ""
                      },
                      {
                        "name": "referenceField",
                        "kind": "optional",
                        "type": "string",
                        "description": ""
                      },
                      {
                        "name": "relationName",
                        "kind": "optional",
                        "type": "string",
                        "description": ""
                      },
                      {
                        "name": "relationLabel",
                        "kind": "optional",
                        "type": "string",
                        "description": ""
                      }
                    ]
                  },
                  {
                    "name": "masterDetailRelation",
                    "kind": "optional",
                    "type": "object",
                    "description": "",
                    "modelRef": "#/components/schemas/MasterDetailRelation",
                    "customType": "MasterDetailRelation",
                    "schema": [
                      {
                        "name": "referenceTo",
                        "kind": "optional",
                        "type": "string",
                        "description": ""
                      },
                      {
                        "name": "referenceField",
                        "kind": "optional",
                        "type": "string",
                        "description": ""
                      },
                      {
                        "name": "relationName",
                        "kind": "optional",
                        "type": "string",
                        "description": ""
                      },
                      {
                        "name": "relationLabel",
                        "kind": "optional",
                        "type": "string",
                        "description": ""
                      },
                      {
                        "name": "detailRelationName",
                        "kind": "optional",
                        "type": "string",
                        "description": ""
                      },
                      {
                        "name": "detailRelationLabel",
                        "kind": "optional",
                        "type": "string",
                        "description": ""
                      }
                    ]
                  },
                  {
                    "name": "autoNumberSetting",
                    "kind": "optional",
                    "type": "object",
                    "description": "auto number customization settings including displayFormat and startValue",
                    "example": "{\"displayFormat\":\"CUSTOM-INV-{00000000}\",\"startValue\":1}",
                    "modelRef": "#/components/schemas/AutoNumberSetting",
                    "customType": "AutoNumberSetting",
                    "schema": [
                      {
                        "name": "displayFormat",
                        "kind": "optional",
                        "type": "string",
                        "description": "Auto number display format",
                        "example": "CUSTOM-INV-{00000000}"
                      },
                      {
                        "name": "startValue",
                        "kind": "optional",
                        "type": "integer<int64>",
                        "description": "Starting number of the auto number field",
                        "example": 1,
                        "format": "int64",
                        "minimum": 1,
                        "maximum": 999999999999
                      }
                    ]
                  }
                ]
              },
              {
                "name": "relations",
                "kind": "optional",
                "type": "array",
                "description": "",
                "modelRef": "#/components/schemas/RelationMetadata",
                "customType": "RelationMetadata[]",
                "schema": [
                  {
                    "name": "referenceObjectName",
                    "kind": "optional",
                    "type": "string",
                    "description": ""
                  },
                  {
                    "name": "referenceFieldName",
                    "kind": "optional",
                    "type": "string",
                    "description": ""
                  },
                  {
                    "name": "relationFieldName",
                    "kind": "optional",
                    "type": "string",
                    "description": ""
                  },
                  {
                    "name": "relationName",
                    "kind": "optional",
                    "type": "string",
                    "description": ""
                  },
                  {
                    "name": "relationLabel",
                    "kind": "optional",
                    "type": "string",
                    "description": ""
                  },
                  {
                    "name": "relationType",
                    "kind": "optional",
                    "type": "string",
                    "description": ""
                  },
                  {
                    "name": "detailAccessPolicy",
                    "kind": "optional",
                    "type": "object",
                    "description": "",
                    "modelRef": "#/components/schemas/DetailAccessPolicy",
                    "customType": "DetailAccessPolicy",
                    "schema": [
                      {
                        "name": "viewable",
                        "kind": "optional",
                        "type": "boolean",
                        "description": ""
                      },
                      {
                        "name": "creatable",
                        "kind": "optional",
                        "type": "boolean",
                        "description": ""
                      },
                      {
                        "name": "updatable",
                        "kind": "optional",
                        "type": "boolean",
                        "description": ""
                      }
                    ]
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/DescribeRubyObjectResponse",
            "isExpanded": true
          }
        ]
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "example-0-curl",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url https://api.nue.io/metadata/objects \\\n     --header 'accept: application/json'"
        },
        {
          "id": "example-1-javascript",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n   method: 'GET',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"https://api.nue.io/metadata/objects\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "example-2-ruby",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.nue.io/metadata/objects\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "example-3-python",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api.nue.io/metadata/objects\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "example-0-curl"
    },
    "results": {
      "languages": [
        {
          "id": "response-0-200",
          "language": "200",
          "code": "// OK\n[\n  {\n    \"apiName\": \"Order\",\n    \"name\": \"Order\",\n    \"description\": \"Represents a booking transaction between a company and a customer to provision services or deliver products with contracted quantities, prices, and terms.\",\n    \"salesforceApiName\": \"Order\",\n    \"endpoint\": \"/metadata/objects/Order\",\n    \"customizable\": true,\n    \"feature\": \"OrderManagement\",\n    \"objectType\": \"Entity\",\n    \"pluralName\": \"Orders\",\n    \"nameField\": \"\",\n    \"fields\": [\n      {\n        \"apiName\": \"Ruby__Trial__c\",\n        \"name\": \"Trial\",\n        \"type\": \"pickList\",\n        \"description\": \"Indicates whether this order is a trial order\",\n        \"creatable\": true,\n        \"updatable\": true,\n        \"filterable\": true,\n        \"sortable\": true,\n        \"customField\": true,\n        \"encrypted\": false,\n        \"defaultValue\": \"\",\n        \"inlineHelpText\": \"\",\n        \"required\": false,\n        \"unique\": false,\n        \"exportId\": false,\n        \"minLength\": \"\",\n        \"maxLength\": \"\",\n        \"valueSet\": {\n          \"apiName\": \"\",\n          \"name\": \"\",\n          \"defaultValue\": \"\",\n          \"alphabeticallyOrdered\": false,\n          \"valuePairs\": [\n            {\n              \"apiName\": \"High\",\n              \"name\": \"High Priority\",\n              \"orderNumber\": 1,\n              \"active\": true\n            }\n          ]\n        },\n        \"precision\": \"\",\n        \"scale\": \"\",\n        \"salesforceApiName\": \"\",\n        \"lookupRelation\": {\n          \"referenceTo\": \"\",\n          \"referenceField\": \"\",\n          \"relationName\": \"\",\n          \"relationLabel\": \"\"\n        },\n        \"masterDetailRelation\": {\n          \"referenceTo\": \"\",\n          \"referenceField\": \"\",\n          \"relationName\": \"\",\n          \"relationLabel\": \"\",\n          \"detailRelationName\": \"\",\n          \"detailRelationLabel\": \"\"\n        },\n        \"autoNumberSetting\": {\n          \"displayFormat\": \"CUSTOM-INV-{00000000}\",\n          \"startValue\": 1\n        }\n      }\n    ],\n    \"relations\": [\n      {\n        \"referenceObjectName\": \"\",\n        \"referenceFieldName\": \"\",\n        \"relationFieldName\": \"\",\n        \"relationName\": \"\",\n        \"relationLabel\": \"\",\n        \"relationType\": \"\",\n        \"detailAccessPolicy\": {\n          \"viewable\": false,\n          \"creatable\": false,\n          \"updatable\": false\n        }\n      }\n    ]\n  }\n]"
        }
      ],
      "selectedLanguageId": "response-0-200"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}