Skip to main content
GET
/
v1
/
entity_types
List Entity Types
curl --request GET \
  --url https://api.us.lexful.app/v1/entity_types \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Account-ID: <api-key>'
{
  "items": [
    {
      "id": "019983a9-c4bf-77da-a35b-5eb177b7b859",
      "account_id": "019983a9-c4bf-77da-a35b-5eb177b7b859",
      "name": "system.contact",
      "display_name": "Contacts",
      "description": "Contacts are people and identities associated with an organization",
      "is_system": true,
      "properties": [
        {
          "name": "first_name",
          "type": "string",
          "display_name": "First Name",
          "required": false
        },
        {
          "name": "last_name",
          "type": "string",
          "display_name": "Last Name",
          "required": false
        },
        {
          "name": "title",
          "type": "string",
          "display_name": "Title",
          "required": false
        },
        {
          "name": "important",
          "type": "boolean",
          "display_name": "Important",
          "required": true
        },
        {
          "name": "contact_type",
          "type": "string",
          "display_name": "Contact Type",
          "required": false,
          "enum": [
            "Approver",
            "Champion",
            "Decision Maker",
            "End User",
            "Evaluator",
            "Influencer",
            "Owner",
            "Other"
          ]
        },
        {
          "name": "contact_methods",
          "type": "array",
          "display_name": "Contact Methods",
          "required": false,
          "array": {
            "type": "object",
            "properties": [
              {
                "name": "type",
                "type": "string",
                "display_name": "Contact Method Type",
                "required": true,
                "enum": [
                  "Phone",
                  "Fax",
                  "Mobile",
                  "Email",
                  "Website",
                  "Twitter",
                  "LinkedIn",
                  "Other"
                ]
              },
              {
                "name": "value",
                "type": "string",
                "display_name": "Contact Method Value",
                "required": true
              }
            ]
          }
        },
        {
          "name": "preferred_contact_method",
          "type": "string",
          "display_name": "Preferred Contact Method",
          "required": false,
          "enum": [
            "Phone",
            "Fax",
            "Mobile",
            "Email",
            "Website",
            "Twitter",
            "LinkedIn",
            "Other"
          ]
        },
        {
          "name": "notes",
          "type": "richtext",
          "display_name": "Notes",
          "required": false
        }
      ],
      "references": [
        {
          "name": "location",
          "display_name": "Location",
          "required": false,
          "multiple": false,
          "target_entity_types": [
            "system.location"
          ]
        }
      ],
      "version": 1,
      "created_at": "2024-01-15T10:30:00.000Z",
      "updated_at": "2024-01-15T10:30:00.000Z",
      "created_by": "019983a9-c4c0-73af-aec9-463feeadc2e7",
      "updated_by": "019983a9-c4c0-73af-aec9-463feeadc2e7"
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Authorizations

Authorization
string
header
required

Bearer token

X-Account-ID
string
header
required

Account ID

Query Parameters

names
string[]

Filter by one or more entity type names

display_name
string

Filter by display name

is_system
boolean

Filter by system flag

limit
number
default:100
Required range: 1 <= x <= 1000
offset
number
default:0
Required range: x >= 0

Response

Default Response

items
object[]
required
total
number
required

Total number of items available

limit
number
required

Number of items returned

offset
number
required

Number of items skipped