Skip to main content
GET
/
v1
/
entities
/
{entityTypeName}
List Entities
curl --request GET \
  --url https://api.us.lexful.app/v1/entities/{entityTypeName} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Account-ID: <api-key>'
{
  "items": [
    {
      "id": "019983a9-c4c0-73af-aec9-463feeadc2e7",
      "organization_id": "019983a9-c4bf-77da-a35b-5eb177b7b859",
      "organization_name": "Acme Corporation",
      "visibility": "inherit",
      "owned_by": "019983a9-c4c0-73af-aec9-463feeadc2e7",
      "name": "John Doe",
      "first_name": "John",
      "last_name": "Doe",
      "title": "CTO",
      "important": true,
      "contact_type": "Decision Maker",
      "contact_methods": [
        {
          "type": "Email",
          "value": "john.doe@example.com"
        },
        {
          "type": "Mobile",
          "value": "+1-555-0123"
        }
      ],
      "preferred_contact_method": "Email",
      "references": {
        "location": "019983a9-c4c1-7abc-def0-123456789abc"
      },
      "created_at": "2024-01-15T10:30:00.000Z",
      "updated_at": "2024-01-20T14:45: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

Path Parameters

entityTypeName
string
required

Entity type name

Query Parameters

organization_id
string<uuid>

Filter by organization

name
string

Filter by entity name

Full-text search query

include_deleted
boolean

Include soft-deleted entities in results (default: false)

expand
string

Comma-separated list of fields to expand (e.g., "labels", "references", "references.referenceName")

fields
string

Comma-separated list of fields to return, or "*" for all fields. Default excludes richtext fields for performance.

sort
string

Field name to sort by

order
enum<string>

Sort order

Available options:
ASC,
DESC
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