Skip to main content
GET
/
v1
/
objects
List all objects in the workspace
curl --request GET \
  --url https://app.nex.ai/api/developers/v1/objects \
  --header 'Authorization: <api-key>'
{
  "data": [
    {
      "id": "123",
      "slug": "person",
      "name": "Person",
      "name_plural": "People",
      "type": "person",
      "description": "",
      "created_at": "2024-01-01T00:00:00Z",
      "attributes": [
        {
          "id": "456",
          "slug": "name",
          "type": "full_name",
          "name": "Name",
          "description": "",
          "options": {
            "is_multi_value": false,
            "is_required": true,
            "is_unique": false
          }
        },
        {
          "id": "789",
          "slug": "email_addresses",
          "type": "email",
          "name": "Email Addresses",
          "description": "",
          "options": {
            "is_multi_value": true,
            "is_required": false,
            "is_unique": true
          }
        }
      ]
    },
    {
      "id": "456",
      "slug": "company",
      "name": "Company",
      "name_plural": "Companies",
      "type": "company",
      "description": "",
      "created_at": "2024-01-01T00:00:00Z",
      "attributes": [
        {
          "id": "987",
          "slug": "name",
          "type": "text",
          "name": "Name",
          "description": "",
          "options": {
            "is_multi_value": false,
            "is_required": true,
            "is_unique": false
          }
        },
        {
          "id": "654",
          "slug": "domains",
          "type": "domain",
          "name": "Domains",
          "description": "",
          "options": {
            "is_multi_value": true,
            "is_required": false,
            "is_unique": true
          }
        },
        {
          "id": "321",
          "slug": "industries",
          "type": "select",
          "name": "Industries",
          "description": "",
          "options": {
            "is_multi_value": true,
            "is_required": false,
            "is_unique": false,
            "select_options": [
              {
                "id": "tech",
                "name": "Technology"
              },
              {
                "id": "finance",
                "name": "Financial Services"
              },
              {
                "id": "healthcare",
                "name": "Healthcare"
              },
              {
                "id": "retail",
                "name": "Retail"
              }
            ]
          }
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

API key for authentication (format: "Bearer YOUR_API_KEY")

Query Parameters

include_attributes
boolean

Include attribute definitions for each object

Response

List of objects

data
object[]