Get an object

v1.0.0

Gets a single object by its object_id or slug.

Required scopes: object_configuration:read.

Input

{
  "type": "object",
  "properties": {
    "object": {
      "type": "string",
      "description": "A UUID or slug to identify the object."
    }
  },
  "required": [
    "object"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "Success",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "api_slug",
        "created_at",
        "id",
        "plural_noun",
        "singular_noun"
      ],
      "properties": {
        "api_slug": {
          "type": [
            "string",
            "null"
          ],
          "description": "A unique, human-readable slug to access the object through URLs and API calls. Formatted in snake case."
        },
        "created_at": {
          "type": "string",
          "description": "When the object was created."
        },
        "id": {
          "type": "object",
          "required": [
            "object_id",
            "workspace_id"
          ],
          "properties": {
            "object_id": {
              "type": "string",
              "format": "uuid",
              "description": "A UUID to identify the object."
            },
            "workspace_id": {
              "type": "string",
              "format": "uuid",
              "description": "A UUID to identify the workspace this object belongs to."
            }
          }
        },
        "plural_noun": {
          "type": [
            "string",
            "null"
          ],
          "description": "The plural form of the object's name."
        },
        "singular_noun": {
          "type": [
            "string",
            "null"
          ],
          "description": "The singular form of the object's name."
        }
      }
    }
  }
}