Skip to main content
Tools Reference

Lexful Tools

Written By Christopher Scaminaci

Last updated 7 days ago

Lexful Tools

lexful_ · 90 tools · Free 30 · Pro 60 IT documentation platform in the Hudu and IT Glue lane, despite the name. Credentials are an API key id and secret plus an account id, and all three are required - the key alone is refused. Paging is offset and limit, default 100 and maximum 1000, returning items with a total; search is the exception at default 20 and maximum 100. A single-object read returns the bare object. Filtering is a bracket grammar over any property, including tenant-defined ones. Asset shapes are defined by your own tenant, so responses are passed through unchanged and the asset type name is treated as opaque. Deletes are mostly soft, with restore endpoints for assets and organizations. Two secure-value reads return stored secrets in plaintext and sit at Pro under their own scope. The vendor publishes no rate limit.

All connector tools · Lexful setup guide

Lexful tool groups

Assets

ToolPlanAccessSummary
lexful_add_related_assetsProWriteLink assets to one asset.
lexful_bulk_delete_assetsProDestructiveDelete MANY assets of one type in a single call; the ids ride in the body.
lexful_create_assetProWriteCreate an asset of one type.
lexful_delete_assetProDestructiveDelete one asset.
lexful_get_assetFreeRead-onlyGet one asset by id.
lexful_get_asset_countsFreeRead-onlyGet asset counts by type — the cheapest way to see what a Lexful account actually contains and which asset types are worth reading.
lexful_get_asset_revisionFreeRead-onlyGet one historical revision of an asset — the record as it stood at that point in time.
lexful_list_asset_revisionsFreeRead-onlyList an asset's revision history — what changed and when.
lexful_list_assetsFreeRead-onlyList assets of one type, with the full filter grammar.
lexful_list_related_assetsFreeRead-onlyList the assets related to one asset — the documentation graph around a record, for example the contacts and devices attached to a site.
lexful_remove_related_assetsProWriteUnlink related assets from one asset.
lexful_restore_asset_to_revisionProDestructiveRoll an asset back to an earlier revision.
lexful_restore_assetsProWriteRestore soft-deleted assets.
lexful_update_assetProWriteUpdate one asset's properties.
lexful_update_related_assetsProWriteUpdate the related-asset links on one asset.

[Lexful] Delete MANY assets of one type in a single call; the ids ride in the body. DESTRUCTIVE and wide — check the id list before running. Soft-deleted, so lexful_restore_assets can bring them back. This is a separate operation from lexful_delete_asset and the two are deliberately not collapsed: Lexful gives the same path shape two different meanings.

ParamTypeRequiredDefaultDescription
assetTypeNamestringyesThe asset type name, as it appears in the path — an opaque string from lexful_list_asset_types. System types are dot-namespaced (for example system.contact); custom types are not. Never construct or parse this.
fieldsJsonstringyesJSON object body carrying the ids of the assets to delete.

[Lexful] Create an asset of one type. Additive: it adds a record and changes nothing existing. The body's shape is defined by the asset TYPE — read lexful_get_asset_type first to see which properties exist and which are required, because they are account-specific.

ParamTypeRequiredDefaultDescription
assetTypeNamestringyesThe asset type name, as it appears in the path — an opaque string from lexful_list_asset_types. System types are dot-namespaced (for example system.contact); custom types are not. Never construct or parse this.
fieldsJsonstringyesJSON object body for the new asset. Its properties are whatever the asset type defines — read lexful_get_asset_type for the schema.

[Lexful] Delete one asset. DESTRUCTIVE. Lexful soft-deletes, so the record can be brought back with lexful_restore_assets and still appears in reads that include deleted items — but it disappears from every ordinary read until then.

ParamTypeRequiredDefaultDescription
assetIdstringyesThe asset's id (a UUID).
assetTypeNamestringyesThe asset type name, as it appears in the path — an opaque string from lexful_list_asset_types. System types are dot-namespaced (for example system.contact); custom types are not. Never construct or parse this.

[Lexful] Get one asset by id. Returns the BARE object, not the {items, total, limit, offset} envelope the list tools use. Secure (secret) properties are NOT included here — reading one is a separate, separately-permissioned tool.

ParamTypeRequiredDefaultDescription
assetIdstringyesThe asset's id (a UUID), from lexful_list_assets or lexful_search.
assetTypeNamestringyesThe asset type name, as it appears in the path — an opaque string from lexful_list_asset_types. System types are dot-namespaced (for example system.contact); custom types are not. Never construct or parse this.
expandstringnonullOptional comma-separated relationships to expand inline.
includeDeletedbooleannonullSet true to return the asset even if it is soft-deleted.

[Lexful] Get asset counts by type — the cheapest way to see what a Lexful account actually contains and which asset types are worth reading. Use this before listing assets so you know which type names exist and roughly how much data each holds.

[Lexful] Get one historical revision of an asset — the record as it stood at that point in time. Read this before restoring to a revision, so you can see exactly what the restore would put back.

ParamTypeRequiredDefaultDescription
assetIdstringyesThe asset's id (a UUID).
assetTypeNamestringyesThe asset type name, as it appears in the path — an opaque string from lexful_list_asset_types. System types are dot-namespaced (for example system.contact); custom types are not. Never construct or parse this.
revisionIdstringyesThe revision id, from lexful_list_asset_revisions.

[Lexful] List an asset's revision history — what changed and when. The revision ids returned here are what lexful_get_asset_revision and lexful_restore_asset_to_revision take. Returns {items, total, limit, offset}.

ParamTypeRequiredDefaultDescription
assetIdstringyesThe asset's id (a UUID).
assetTypeNamestringyesThe asset type name, as it appears in the path — an opaque string from lexful_list_asset_types. System types are dot-namespaced (for example system.contact); custom types are not. Never construct or parse this.
limitintegernonullResults per page (1-1000, default 100). Larger values are clamped.
offsetintegernonullZero-based offset for paging. The response carries {items, total, limit, offset}; page by adding limit to offset until offset >= total.

[Lexful] List assets of one type, with the full filter grammar. Because asset properties are defined per account, filtering is a raw query fragment rather than fixed parameters: pass filters as field[operator]=value, joining several with &. Operators: eq, ne, gt, gte, lt, lte, between (comma pair), in, nin, null, like (case-sensitive), ilike (case-insensitive), contains, startswith, endswith — % is the wildcard, e.g. name[like]=Acme% — plus array_contains (takes a JSON object literal, e.g. contact_methods[array_contains]={"type":"Email"}), array_empty and array_length_eq|ne|gt|gte|lt|lte. Reference properties use dot notation (references.=, comma-separated for several). Returns {items, total, limit, offset}; each item's property set depends on the asset type.

ParamTypeRequiredDefaultDescription
assetTypeNamestringyesThe asset type name, as it appears in the path — an opaque string from lexful_list_asset_types. System types are dot-namespaced (for example system.contact); custom types are not. Never construct or parse this.
expandstringnonullOptional comma-separated relationships to expand inline instead of returning ids only.
fieldsstringnonullOptional comma-separated property names to return instead of the full record — useful for keeping large asset types readable.
filtersstringnonullOptional raw filter fragment in Lexful's bracket grammar, e.g. name[ilike]=acme% or status[in]=active,onboarding. Join several with &. Omit the leading ? or &.
includeDeletedbooleannonullSet true to include soft-deleted assets. Lexful soft-deletes, so a 'missing' asset is often still here.
limitintegernonullResults per page (1-1000, default 100). Larger values are clamped.
offsetintegernonullZero-based offset for paging. The response carries {items, total, limit, offset}; page by adding limit to offset until offset >= total.
orderstringnonullOptional sort direction, asc or desc.
organizationIdstringnonullOptional organization id, to scope results to one client.
sortstringnonullOptional property name to sort by.
tagsstringnonullOptional comma-separated tag filter.

[Lexful] Roll an asset back to an earlier revision. DESTRUCTIVE despite the friendly name: this OVERWRITES the current record, so every change made since that revision is lost. Unlike lexful_restore_assets — which merely undeletes — this discards work. Read the target revision with lexful_get_asset_revision first to see exactly what will be put back.

ParamTypeRequiredDefaultDescription
assetIdstringyesThe asset's id (a UUID).
assetTypeNamestringyesThe asset type name, as it appears in the path — an opaque string from lexful_list_asset_types. System types are dot-namespaced (for example system.contact); custom types are not. Never construct or parse this.
revisionIdstringyesThe revision id to roll back to, from lexful_list_asset_revisions.

[Lexful] Restore soft-deleted assets. Strictly additive — the inverse of a delete, bringing records back into ordinary reads without overwriting anything.

ParamTypeRequiredDefaultDescription
assetTypeNamestringyesThe asset type name, as it appears in the path — an opaque string from lexful_list_asset_types. System types are dot-namespaced (for example system.contact); custom types are not. Never construct or parse this.
fieldsJsonstringyesJSON object body carrying the ids of the assets to restore.

[Lexful] Update one asset's properties. A partial edit — properties you omit are left alone rather than cleared — and Lexful keeps a revision, so the previous state stays readable through lexful_list_asset_revisions.

ParamTypeRequiredDefaultDescription
assetIdstringyesThe asset's id (a UUID).
assetTypeNamestringyesThe asset type name, as it appears in the path — an opaque string from lexful_list_asset_types. System types are dot-namespaced (for example system.contact); custom types are not. Never construct or parse this.
fieldsJsonstringyesJSON object body carrying the properties to change. Omitted properties are left as they are.

Secure Values

ToolPlanAccessSummary
lexful_get_secure_valueProRead-onlyRead a stored secret in PLAINTEXT from an asset property — a documented password, key or other credential.
lexful_get_secure_value_from_revisionProRead-onlyRead a stored secret in PLAINTEXT as it was at an earlier revision — which by construction can return a credential that has SINCE BEEN ROTATED out of the current record.

[Lexful] Read a stored secret in PLAINTEXT from an asset property — a documented password, key or other credential. Reads only and changes nothing, but it egresses a real credential, so it sits behind its own permission and the Pro tier rather than the general asset-read permission. Use it only when the secret itself is genuinely needed; lexful_get_asset returns the rest of the record without it. The property must be one the asset type defines as secure — read lexful_get_asset_type to see which properties those are.

ParamTypeRequiredDefaultDescription
assetIdstringyesThe asset's id (a UUID).
assetTypeNamestringyesThe asset type name, from lexful_list_asset_types. System types are dot-namespaced (e.g. system.contact).
propertyNamestringyesThe name of the secure property to read, as defined on the asset type.

[Lexful] Read a stored secret in PLAINTEXT as it was at an earlier revision — which by construction can return a credential that has SINCE BEEN ROTATED out of the current record. Useful for recovering a value someone overwrote by mistake; treat the result with the same care as a live credential, since an old password is often still in use somewhere. Same permission and tier as the current-value tool, and for the same reason.

ParamTypeRequiredDefaultDescription
assetIdstringyesThe asset's id (a UUID).
assetTypeNamestringyesThe asset type name, from lexful_list_asset_types.
propertyNamestringyesThe name of the secure property to read, as defined on the asset type.
revisionIdstringyesThe revision id, from lexful_list_asset_revisions.

Asset Types

ToolPlanAccessSummary
lexful_add_asset_type_propertyProWriteAdd a property to an asset type.
lexful_add_asset_type_referenceProWriteAdd a reference to an asset type — a defined relationship to another type, which is what makes cross-linking assets possible.
lexful_archive_asset_typeProDestructiveArchive an asset type.
lexful_create_asset_typeProWriteCreate a new asset type.
lexful_delete_asset_type_propertyProDestructiveDelete a property from an asset type.
lexful_delete_asset_type_referenceProDestructiveDelete a reference definition from an asset type.
lexful_get_asset_typeFreeRead-onlyGet one asset type, including its property definitions and its references (relationships to other types).
lexful_list_asset_typesFreeRead-onlyList asset types — the schemas defined in this Lexful account.
lexful_update_asset_typeProWriteUpdate an asset type's own attributes, such as its name or description.
lexful_update_asset_type_propertyProWriteUpdate a property definition on an asset type — for example its label or its options.
lexful_update_asset_type_referenceProWriteUpdate a reference definition on an asset type.

[Lexful] Add a property to an asset type. Additive — existing assets of the type simply gain an empty property, and no stored data is touched.

ParamTypeRequiredDefaultDescription
assetTypeIdstringyesThe asset type's id (a UUID).
fieldsJsonstringyesJSON object body defining the property, including its type.
propertyNamestringyesThe name of the property to add.

[Lexful] Add a reference to an asset type — a defined relationship to another type, which is what makes cross-linking assets possible. Additive.

ParamTypeRequiredDefaultDescription
assetTypeIdstringyesThe asset type's id (a UUID).
fieldsJsonstringyesJSON object body defining the reference, including the type it points at.
referenceNamestringyesThe name of the reference to add.

[Lexful] Archive an asset type. DESTRUCTIVE: the vendor calls this 'archive' rather than 'delete', but it takes the entire type — and the visibility of every asset filed under it — out of service in one call. The gentler name does not mean a smaller blast radius. Check lexful_get_asset_counts first to see how many assets that type holds.

ParamTypeRequiredDefaultDescription
assetTypeIdstringyesThe asset type's id (a UUID).

[Lexful] Create a new asset type. Additive — it defines a new schema and touches nothing existing. No assets exist under it until they are created.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object body defining the new asset type, including its properties.

[Lexful] Delete a property from an asset type. DESTRUCTIVE, and the WIDEST-REACHING call in this connector: removing the property DROPS THAT PROPERTY'S DATA ACROSS EVERY ASSET OF THE TYPE, not just from the schema. Deleting one asset loses one record; this loses one field from all of them at once. If the property holds a secure value, that stored secret goes with it. Be certain before running this.

ParamTypeRequiredDefaultDescription
assetTypeIdstringyesThe asset type's id (a UUID).
propertyNamestringyesThe name of the property to delete. Its data is removed from every asset of this type.

[Lexful] Delete a reference definition from an asset type. DESTRUCTIVE: removing the relationship definition takes the links built on it with it, so the documentation graph between those two types is lost across every asset that used it.

ParamTypeRequiredDefaultDescription
assetTypeIdstringyesThe asset type's id (a UUID).
referenceNamestringyesThe name of the reference to delete.

[Lexful] Get one asset type, including its property definitions and its references (relationships to other types). Read this before creating or updating an asset: it is the only way to know which properties exist, which are required, and which are SECURE properties whose values need the dedicated secure-value tool rather than an ordinary read.

ParamTypeRequiredDefaultDescription
assetTypeIdstringyesThe asset type's id (a UUID), from lexful_list_asset_types. Note this is the id, not the type NAME that asset paths use.

[Lexful] List asset types — the schemas defined in this Lexful account. START HERE when working with assets: the type NAME returned by this tool is the assetTypeName every asset tool takes in its path, and the type's property definitions tell you what an asset of that type actually contains. System types are dot-namespaced (for example system.contact); custom types are whatever the account defined. Returns {items, total, limit, offset}.

ParamTypeRequiredDefaultDescription
limitintegernonullResults per page (1-1000, default 100). Larger values are clamped.
offsetintegernonullZero-based offset for paging.

[Lexful] Update an asset type's own attributes, such as its name or description. A partial edit that does not remove properties — removing a property is a separate, destructive tool.

ParamTypeRequiredDefaultDescription
assetTypeIdstringyesThe asset type's id (a UUID).
fieldsJsonstringyesJSON object body carrying the attributes to change.

[Lexful] Update a property definition on an asset type — for example its label or its options. Changes the definition, not the stored values.

ParamTypeRequiredDefaultDescription
assetTypeIdstringyesThe asset type's id (a UUID).
fieldsJsonstringyesJSON object body carrying the definition changes.
propertyNamestringyesThe name of the property to update.

[Lexful] Update a reference definition on an asset type. Changes the definition of the relationship, not the links that already exist between records.

ParamTypeRequiredDefaultDescription
assetTypeIdstringyesThe asset type's id (a UUID).
fieldsJsonstringyesJSON object body carrying the definition changes.
referenceNamestringyesThe name of the reference to update.

Asset Files

ToolPlanAccessSummary
lexful_delete_asset_fileProDestructiveDelete a file attached to an asset.
lexful_get_asset_fileFreeRead-onlyGet one attached file's metadata — name, size, content type and timestamps.
lexful_get_asset_file_download_urlFreeRead-onlyGet a time-limited download URL for an attached file.
lexful_list_asset_filesFreeRead-onlyList the files attached to an asset — their names, sizes and metadata, not their contents.
lexful_update_asset_fileProWriteUpdate an attached file's metadata, such as its display name.

[Lexful] Delete a file attached to an asset. DESTRUCTIVE: unlike assets and organizations, there is no restore endpoint for files, and StackJack cannot upload a replacement — the presigned upload flows are not available as tools. Removing a document here means re-attaching it through the Lexful interface.

ParamTypeRequiredDefaultDescription
assetIdstringyesThe asset's id (a UUID).
assetTypeNamestringyesThe asset type name, from lexful_list_asset_types. System types are dot-namespaced (e.g. system.contact).
fileIdstringyesThe file's id, from lexful_list_asset_files.

[Lexful] Get one attached file's metadata — name, size, content type and timestamps. This does NOT return the file's bytes; use lexful_get_asset_file_download_url for a link to the content.

ParamTypeRequiredDefaultDescription
assetIdstringyesThe asset's id (a UUID).
assetTypeNamestringyesThe asset type name, from lexful_list_asset_types. System types are dot-namespaced (e.g. system.contact).
fileIdstringyesThe file's id, from lexful_list_asset_files.

[Lexful] Get a time-limited download URL for an attached file. Returns ordinary JSON containing the link — the file's bytes do not pass through StackJack. Treat the URL as sensitive while it lasts: anyone holding it can fetch the document without authenticating again.

ParamTypeRequiredDefaultDescription
assetIdstringyesThe asset's id (a UUID).
assetTypeNamestringyesThe asset type name, from lexful_list_asset_types. System types are dot-namespaced (e.g. system.contact).
fileIdstringyesThe file's id, from lexful_list_asset_files.

[Lexful] List the files attached to an asset — their names, sizes and metadata, not their contents. The file id returned here is what the get, download, update and delete file tools take. Returns {items, total, limit, offset}.

ParamTypeRequiredDefaultDescription
assetIdstringyesThe asset's id (a UUID).
assetTypeNamestringyesThe asset type name, from lexful_list_asset_types. System types are dot-namespaced (e.g. system.contact).
limitintegernonullResults per page (1-1000, default 100). Larger values are clamped.
offsetintegernonullZero-based offset for paging.

[Lexful] Update an attached file's metadata, such as its display name. Changes the record about the file, never the file's contents.

ParamTypeRequiredDefaultDescription
assetIdstringyesThe asset's id (a UUID).
assetTypeNamestringyesThe asset type name, from lexful_list_asset_types. System types are dot-namespaced (e.g. system.contact).
fieldsJsonstringyesJSON object body carrying the metadata to change.
fileIdstringyesThe file's id, from lexful_list_asset_files.

Access Grants

ToolPlanAccessSummary
lexful_add_asset_access_grantsProWriteGrant access to one asset.
lexful_add_tag_access_grantsProWriteGrant access through a tag, which reaches everything currently carrying that tag and everything tagged with it later.
lexful_bulk_add_asset_access_grantsProWriteGrant access across EVERY asset of one type at once.
lexful_list_asset_access_grantsFreeRead-onlyList who has been granted access to one asset.
lexful_list_tag_access_grantsFreeRead-onlyList who has been granted access through one tag.
lexful_remove_asset_access_grantsProWriteRevoke access to one asset.
lexful_remove_tag_access_grantsProWriteRevoke a tag-based grant.

[Lexful] Grant access to one asset. Additive and reversible — it widens who can see the record, and lexful_remove_asset_access_grants undoes it. Remember that granting access to an asset can expose any secure values stored on it.

ParamTypeRequiredDefaultDescription
assetIdstringyesThe asset's id (a UUID).
assetTypeNamestringyesThe asset type name, from lexful_list_asset_types. System types are dot-namespaced (e.g. system.contact).
fieldsJsonstringyesJSON object body naming the users or groups to grant access to.

[Lexful] Grant access through a tag, which reaches everything currently carrying that tag and everything tagged with it later. Additive and reversible, but the reach is indirect — check what the tag covers before granting.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object body naming the users or groups to grant access to.
tagIdstringyesThe tag's id (a UUID), from lexful_list_tags.

[Lexful] Grant access across EVERY asset of one type at once. Additive, but wide: this can expose a whole category of documentation — including any secure values stored on those assets — to everyone named in the body. Confirm the type before running it.

ParamTypeRequiredDefaultDescription
assetTypeNamestringyesThe asset type name, from lexful_list_asset_types. System types are dot-namespaced (e.g. system.contact).
fieldsJsonstringyesJSON object body naming the users or groups to grant access to across the whole type.

[Lexful] List who has been granted access to one asset. Read this before changing grants so you can see the current state — the add and remove tools work from the ids listed here. Returns {items, total, limit, offset}.

ParamTypeRequiredDefaultDescription
assetIdstringyesThe asset's id (a UUID).
assetTypeNamestringyesThe asset type name, from lexful_list_asset_types. System types are dot-namespaced (e.g. system.contact).
limitintegernonullResults per page (1-1000, default 100). Larger values are clamped.
offsetintegernonullZero-based offset for paging.

[Lexful] List who has been granted access through one tag. Tag-based grants apply to everything carrying the tag, so this is often the shortest path to understanding why someone can see a record. Returns {items, total, limit, offset}.

ParamTypeRequiredDefaultDescription
limitintegernonullResults per page (1-1000, default 100). Larger values are clamped.
offsetintegernonullZero-based offset for paging.
tagIdstringyesThe tag's id (a UUID), from lexful_list_tags.

[Lexful] Revoke access to one asset. This TAKES ACCESS AWAY FROM PEOPLE — they lose sight of the record immediately — but nothing is deleted: the users and groups are untouched and lexful_add_asset_access_grants restores the grant exactly. It is classified as a reversible change for that reason, not because the effect is minor. Check the current grants first with lexful_list_asset_access_grants.

ParamTypeRequiredDefaultDescription
assetIdstringyesThe asset's id (a UUID).
assetTypeNamestringyesThe asset type name, from lexful_list_asset_types. System types are dot-namespaced (e.g. system.contact).
fieldsJsonstringyesJSON object body naming the users or groups whose access should be revoked.

[Lexful] Revoke a tag-based grant. Like the asset version this TAKES ACCESS AWAY FROM PEOPLE, across everything the tag covers at once, but deletes nothing and is exactly reversible with lexful_add_tag_access_grants. Read lexful_list_tag_access_grants first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object body naming the users or groups whose access should be revoked.
tagIdstringyesThe tag's id (a UUID), from lexful_list_tags.

Organizations

ToolPlanAccessSummary
lexful_bulk_delete_organizationsProDestructiveDelete MANY organizations in one call; the ids ride in the body.
lexful_bulk_update_organizationsProDestructiveUpdate MANY organizations in one call.
lexful_create_organizationProWriteCreate one or more organizations.
lexful_delete_organizationProDestructiveDelete one organization.
lexful_delete_organization_logoProDestructiveDelete an organization's logo.
lexful_get_organizationFreeRead-onlyGet one organization by id.
lexful_list_organizationsFreeRead-onlyList organizations — the client companies documented in this account.
lexful_restore_organizationsProWriteRestore soft-deleted organizations.
lexful_update_organizationProWriteUpdate one organization's fields.

[Lexful] Delete MANY organizations in one call; the ids ride in the body. DESTRUCTIVE and the widest organization-level action available — it can remove a large part of an account's client list at once. Soft-deleted, so lexful_restore_organizations can recover them. Separate from lexful_delete_organization on purpose: Lexful gives the same path shape two different meanings.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object body carrying the ids of the organizations to delete.

[Lexful] Update MANY organizations in one call. DESTRUCTIVE by blast radius rather than by verb: it rewrites fields across a whole set of client records at once, and there is no bulk undo — putting it right means another sweep with the old values, which you would need to have captured first. Read the affected organizations before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON body describing the organizations to update and the changes to apply.

[Lexful] Create one or more organizations. Additive. Lexful names this operation in the plural and pairs it with bulk update and delete on the same path, so the body may carry either a single object or an array — whatever you send is passed through unchanged.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON body for the new organization — either a single object or an array of them. May include parent_id to place it in the hierarchy.

[Lexful] Delete one organization. DESTRUCTIVE: it removes a client company from ordinary reads, along with the way its documentation is grouped. Lexful soft-deletes, so lexful_restore_organizations can bring it back. Check for child organizations first — the hierarchy means a parent rarely stands alone.

ParamTypeRequiredDefaultDescription
organizationIdstringyesThe organization's id (a UUID).

[Lexful] Delete an organization's logo. DESTRUCTIVE in the narrow but real sense that StackJack cannot put it back: uploading a replacement needs Lexful's presigned upload flow, which is not available as a tool, so restoring the image means doing it in the Lexful interface. Small blast radius, no undo from here.

ParamTypeRequiredDefaultDescription
organizationIdstringyesThe organization's id (a UUID).

[Lexful] Get one organization by id. Returns the bare object, not the list envelope.

ParamTypeRequiredDefaultDescription
organizationIdstringyesThe organization's id (a UUID), from lexful_list_organizations.

[Lexful] List organizations — the client companies documented in this account. The organization id returned here is the organizationId filter on lexful_list_assets, so this is usually the first call when scoping work to one client. Organizations form a hierarchy: pass parentId to list children of one organization. Supports the same bracket filter grammar as assets (field[operator]=value, e.g. name[ilike]=acme% or status[in]=active,onboarding). Returns {items, total, limit, offset}.

ParamTypeRequiredDefaultDescription
filtersstringnonullOptional raw filter fragment in Lexful's bracket grammar, e.g. name[ilike]=acme%. Join several with &; omit any leading ? or &.
includeDeletedbooleannonullSet true to include soft-deleted organizations.
limitintegernonullResults per page (1-1000, default 100). Larger values are clamped.
offsetintegernonullZero-based offset for paging.
parentIdstringnonullOptional parent organization id, to list that organization's children.
searchstringnonullOptional free-text search across organizations.

[Lexful] Restore soft-deleted organizations. Strictly additive — the inverse of a delete, bringing client records back into ordinary reads.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object body carrying the ids of the organizations to restore.

[Lexful] Update one organization's fields. A partial edit — omitted fields are left as they are.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object body carrying the fields to change.
organizationIdstringyesThe organization's id (a UUID).

Tags

ToolPlanAccessSummary
lexful_add_tag_to_assetsProWriteApply a tag to assets.
lexful_add_tag_to_entitiesProWriteApply a tag to entities.
lexful_add_tag_to_organizationsProWriteApply a tag to organizations.
lexful_bulk_delete_tagsProDestructiveDelete MANY tags in one call; the ids ride in the body.
lexful_create_tagProWriteCreate a tag.
lexful_delete_tagProDestructiveDelete one tag.
lexful_get_tagFreeRead-onlyGet one tag by id.
lexful_list_tagsFreeRead-onlyList tags.
lexful_remove_tag_from_assetsProWriteRemove a tag from assets.
lexful_remove_tag_from_entitiesProWriteRemove a tag from entities.
lexful_remove_tag_from_organizationsProWriteRemove a tag from organizations.
lexful_update_tagProWriteUpdate a tag's own attributes, such as its name or colour.

[Lexful] Apply a tag to assets. A reversible link — nothing is created or destroyed, and lexful_remove_tag_from_assets undoes it exactly. Note that if the tag carries access grants, tagging a record also widens who can see it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object body naming the assets to tag.
tagIdstringyesThe tag's id (a UUID), from lexful_list_tags.

[Lexful] Apply a tag to entities. A reversible link, exactly undone by lexful_remove_tag_from_entities.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object body naming the entities to tag.
tagIdstringyesThe tag's id (a UUID), from lexful_list_tags.

[Lexful] Apply a tag to organizations. A reversible link, exactly undone by lexful_remove_tag_from_organizations.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object body naming the organizations to tag.
tagIdstringyesThe tag's id (a UUID), from lexful_list_tags.

[Lexful] Delete MANY tags in one call; the ids ride in the body. DESTRUCTIVE and wide — every affected tag vanishes from everything it labelled, and any access those tags granted goes with them. Separate from lexful_delete_tag on purpose: Lexful gives the same path shape two different meanings.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object body carrying the ids of the tags to delete.

[Lexful] Create a tag. Additive — a new tag starts applied to nothing.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object body for the new tag.

[Lexful] Delete one tag. DESTRUCTIVE: the tag disappears from everything carrying it, and if the tag carried access grants, the people who could see records through it lose that access at the same time. Check lexful_list_tag_access_grants before deleting.

ParamTypeRequiredDefaultDescription
tagIdstringyesThe tag's id (a UUID), from lexful_list_tags.

[Lexful] Get one tag by id. Returns the bare object, not the list envelope.

ParamTypeRequiredDefaultDescription
tagIdstringyesThe tag's id (a UUID), from lexful_list_tags.

[Lexful] List tags. The tag id returned here is what every other tag tool takes, and is also the tags filter on lexful_list_assets. Returns {items, total, limit, offset}.

ParamTypeRequiredDefaultDescription
limitintegernonullResults per page (1-1000, default 100). Larger values are clamped.
offsetintegernonullZero-based offset for paging.

[Lexful] Remove a tag from assets. NOT a delete: it untags, the assets and the tag both survive, and lexful_add_tag_to_assets restores the state exactly. That is why it is not flagged destructive despite the delete verb.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object body naming the assets to untag.
tagIdstringyesThe tag's id (a UUID), from lexful_list_tags.

[Lexful] Remove a tag from entities. NOT a delete: it untags only, and lexful_add_tag_to_entities restores the state exactly.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object body naming the entities to untag.
tagIdstringyesThe tag's id (a UUID), from lexful_list_tags.

[Lexful] Remove a tag from organizations. NOT a delete: it untags only, and lexful_add_tag_to_organizations restores the state exactly.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object body naming the organizations to untag.
tagIdstringyesThe tag's id (a UUID), from lexful_list_tags.

[Lexful] Update a tag's own attributes, such as its name or colour. Does not change what the tag is applied to.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object body carrying the attributes to change.
tagIdstringyesThe tag's id (a UUID), from lexful_list_tags.

Groups

ToolPlanAccessSummary
lexful_add_users_to_groupProWriteAdd users to a group.
lexful_create_groupProWriteCreate a group.
lexful_delete_groupProDestructiveDelete a group.
lexful_get_groupFreeRead-onlyGet one group by id.
lexful_list_group_usersFreeRead-onlyList the users in a group — the membership behind whatever that group has been granted.
lexful_list_groupsFreeRead-onlyList groups.
lexful_remove_users_from_groupProWriteRemove users from a group.
lexful_update_groupProWriteUpdate a group's own attributes, such as its name.

[Lexful] Add users to a group. A reversible membership change — it gives those users everything the group can reach, and lexful_remove_users_from_group undoes it exactly.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object body naming the users to add.
groupIdstringyesThe group's id (a UUID), from lexful_list_groups.

[Lexful] Create a group. Additive — a new group starts empty and grants nothing until members and access are added.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object body for the new group.

[Lexful] Delete a group. DESTRUCTIVE: the group's members keep their user accounts, but every access grant the group carried disappears with it, so people can lose sight of documentation immediately. Check what the group has been granted before deleting it.

ParamTypeRequiredDefaultDescription
groupIdstringyesThe group's id (a UUID), from lexful_list_groups.

[Lexful] Get one group by id. Returns the bare object, not the list envelope.

ParamTypeRequiredDefaultDescription
groupIdstringyesThe group's id (a UUID), from lexful_list_groups.

[Lexful] List the users in a group — the membership behind whatever that group has been granted. Returns {items, total, limit, offset}.

ParamTypeRequiredDefaultDescription
groupIdstringyesThe group's id (a UUID), from lexful_list_groups.
limitintegernonullResults per page (1-1000, default 100). Larger values are clamped.
offsetintegernonullZero-based offset for paging.

[Lexful] List groups. Groups are the usual unit of access control here, so this is the place to start when working out who can reach what. Returns {items, total, limit, offset}.

ParamTypeRequiredDefaultDescription
limitintegernonullResults per page (1-1000, default 100). Larger values are clamped.
offsetintegernonullZero-based offset for paging.

[Lexful] Remove users from a group. NOT a delete: the user accounts survive untouched and lexful_add_users_to_group puts membership back exactly — which is why this is not flagged destructive despite the delete verb. It does take away whatever access the group provided, so those people lose sight of that documentation until they are re-added.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object body naming the users to remove.
groupIdstringyesThe group's id (a UUID), from lexful_list_groups.

[Lexful] Update a group's own attributes, such as its name. Does not change membership — that is a separate pair of tools.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object body carrying the attributes to change.
groupIdstringyesThe group's id (a UUID), from lexful_list_groups.

Users

ToolPlanAccessSummary
lexful_create_userProWriteCreate a user, provisioning a real person into the platform.
lexful_delete_userProDestructiveDelete a user.
lexful_get_userFreeRead-onlyGet one user by id.
lexful_list_user_rolesFreeRead-onlyList the roles a user can be assigned.
lexful_list_usersFreeRead-onlyList users.
lexful_update_userProWriteUpdate one user's details or role.

[Lexful] Create a user, provisioning a real person into the platform. Additive — nothing existing is changed — and Lexful's API documentation describes no email being sent, so it is not treated as an action that reaches someone. Use lexful_list_user_roles first to get a valid role. If your Lexful account is configured to email invitations, treat this as contacting a person even though the API does not say so.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object body for the new user, including a role from lexful_list_user_roles.

[Lexful] Delete a user. DESTRUCTIVE: it removes a real person's access to the documentation platform immediately, along with their group memberships and grants. Unlike removing someone from a group, this is not a membership change that can simply be added back — the account itself is gone.

ParamTypeRequiredDefaultDescription
userIdstringyesThe user's id (a UUID), from lexful_list_users.

[Lexful] Get one user by id. Returns the bare object, not the list envelope.

ParamTypeRequiredDefaultDescription
userIdstringyesThe user's id (a UUID), from lexful_list_users.

[Lexful] List the roles a user can be assigned. Read this before creating or updating a user — the role names it returns are the valid values for the role field, and they are account-specific.

[Lexful] List users. Returns {items, total, limit, offset}.

ParamTypeRequiredDefaultDescription
limitintegernonullResults per page (1-1000, default 100). Larger values are clamped.
offsetintegernonullZero-based offset for paging.

[Lexful] Update one user's details or role. A partial edit. Changing a role can widen or narrow what that person can see, so check lexful_list_user_roles for what each role means in this account.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object body carrying the fields to change.
userIdstringyesThe user's id (a UUID), from lexful_list_users.

SSO Connections

ToolPlanAccessSummary
lexful_create_sso_connectionProWriteCreate an SSO connection.
lexful_delete_sso_connectionProDestructiveDelete an SSO connection.
lexful_get_sso_connectionFreeRead-onlyGet one SSO connection's configuration.
lexful_get_sso_connection_mappingsFreeRead-onlyGet an SSO connection's attribute mappings — how fields from the identity provider translate into Lexful user attributes.
lexful_list_sso_connectionsFreeRead-onlyList the SSO connections configured for this account — the identity providers people sign in through.
lexful_update_sso_connectionProWriteUpdate an SSO connection's configuration.
lexful_update_sso_connection_mappingsProWriteUpdate how identity-provider attributes map onto Lexful user fields.

[Lexful] Create an SSO connection. Additive — it adds a sign-in path without disturbing any existing one.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object body describing the new SSO connection.

[Lexful] Delete an SSO connection. DESTRUCTIVE, and its effect is wider than the record it removes: everyone who signs in through this identity provider loses their way into the platform at once. Confirm another sign-in path exists before running it.

ParamTypeRequiredDefaultDescription
connectionIdstringyesThe SSO connection's id (a UUID), from lexful_list_sso_connections.

[Lexful] Get one SSO connection's configuration. Returns the bare object, not the list envelope.

ParamTypeRequiredDefaultDescription
connectionIdstringyesThe SSO connection's id (a UUID), from lexful_list_sso_connections.

[Lexful] Get an SSO connection's attribute mappings — how fields from the identity provider translate into Lexful user attributes. This is where to look when people sign in successfully but land with the wrong name, email or role.

ParamTypeRequiredDefaultDescription
connectionIdstringyesThe SSO connection's id (a UUID), from lexful_list_sso_connections.

[Lexful] List the SSO connections configured for this account — the identity providers people sign in through. Returns {items, total, limit, offset}.

ParamTypeRequiredDefaultDescription
limitintegernonullResults per page (1-1000, default 100). Larger values are clamped.
offsetintegernonullZero-based offset for paging.

[Lexful] Update an SSO connection's configuration. A partial edit, but bear in mind it changes a live sign-in path: a wrong value here can stop people authenticating, even though the change itself is reversible.

ParamTypeRequiredDefaultDescription
connectionIdstringyesThe SSO connection's id (a UUID), from lexful_list_sso_connections.
fieldsJsonstringyesJSON object body carrying the configuration to change.

[Lexful] Update how identity-provider attributes map onto Lexful user fields. Reversible — read the current mappings first with lexful_get_sso_connection_mappings so you can put them back if a sign-in starts producing the wrong user details.

ParamTypeRequiredDefaultDescription
connectionIdstringyesThe SSO connection's id (a UUID), from lexful_list_sso_connections.
fieldsJsonstringyesJSON object body carrying the attribute mappings.

Account

ToolPlanAccessSummary
lexful_create_allowed_ipProWriteAdd an IP address or CIDR range to the account's allowlist.
lexful_delete_allowed_ipProDestructiveRemove an entry from the IP allowlist.
lexful_get_account_settingsFreeRead-onlyGet account-wide settings.
lexful_get_allowed_ipFreeRead-onlyGet one IP allowlist entry.
lexful_list_allowed_ipsFreeRead-onlyList the account's IP allowlist — the addresses and CIDR ranges permitted to reach the Lexful API.
lexful_update_account_settingsProDestructiveUpdate account-wide settings.
lexful_update_allowed_ipProWriteUpdate one IP allowlist entry.

[Lexful] Add an IP address or CIDR range to the account's allowlist. Additive — it widens which networks can reach the API and removes nothing.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object body describing the IP address or CIDR range to allow.

[Lexful] Remove an entry from the IP allowlist. DESTRUCTIVE: this can immediately cut off API access from that network — including StackJack's own access, if the entry being removed is what permits it, in which case no further Lexful tool will work until someone restores it through the Lexful interface. Check lexful_list_allowed_ips first.

ParamTypeRequiredDefaultDescription
idstringyesThe allowlist entry's id, from lexful_list_allowed_ips.

[Lexful] Get account-wide settings. Read these before changing any of them — the update is a single account-level write with no per-setting undo.

ParamTypeRequiredDefaultDescription
accountIdstringyesThe Lexful account id — the same value configured as the Account ID on the connector.

[Lexful] Get one IP allowlist entry. Returns the bare object, not the list envelope.

ParamTypeRequiredDefaultDescription
idstringyesThe allowlist entry's id, from lexful_list_allowed_ips.

[Lexful] List the account's IP allowlist — the addresses and CIDR ranges permitted to reach the Lexful API. If API calls started failing from a new location, this is the first thing to check. Returns {items, total, limit, offset}.

ParamTypeRequiredDefaultDescription
limitintegernonullResults per page (1-1000, default 100). Larger values are clamped.
offsetintegernonullZero-based offset for paging.

[Lexful] Update account-wide settings. DESTRUCTIVE by reach rather than by verb: this changes configuration for the ENTIRE Lexful account in one call, affecting every user and every client's documentation, and there is no settings history to roll back to. Read lexful_get_account_settings first and keep the previous values.

ParamTypeRequiredDefaultDescription
accountIdstringyesThe Lexful account id — the same value configured as the Account ID on the connector.
fieldsJsonstringyesJSON object body carrying the settings to change.

[Lexful] Update one IP allowlist entry. Reversible, but take care: narrowing a range can cut off a location that is currently working, including StackJack itself.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object body carrying the changes.
idstringyesThe allowlist entry's id, from lexful_list_allowed_ips.
ToolPlanAccessSummary
lexful_searchFreeRead-onlySearch across assets and organizations at once.

[Lexful] Search across assets and organizations at once. Use this when you know roughly what you are looking for but not which asset type holds it — otherwise lexful_list_assets with a filter is more precise. NOTE the page limit here is 100, lower than the 1000 the other lists allow; larger values are clamped. Returns {items, total, limit, offset}.

ParamTypeRequiredDefaultDescription
limitintegernonullResults per page (1-100, default 20). This endpoint's maximum is 100 — lower than every other Lexful list — and larger values are clamped.
offsetintegernonullZero-based offset for paging. Page by adding limit to offset until offset >= total.
querystringyesThe search text.