Lists

Get one list's metadata

One list's metadata: name, kind (entityType), completionStatus (processing while an import, copy, save-to-list or enrichment is still populating it, complete otherwise — poll this after any 202 that targets the list), the row count, and the enrichment metrics (rows enriched and rows carrying a LinkedIn URL, professional email, personal email or valid phone). metrics is null for a company list, where those counters do not apply. ?include=columns adds the custom and smart column definitions.

Errors:

  • 404 LIST_NOT_FOUND — No list with that id is visible to the token owner.
  • 422 VALIDATION_FAILED — listId is not a 24-hex id, or include is not "columns".
  • 429 RATE_LIMITED — The lists rate bucket is exhausted.

Requires one of the following token scopes: lists.

get/business/lists/{listId}

Request

  • Base URL: https://api.tryfuse.ai/api/v1
  • URL: https://api.tryfuse.ai/api/v1/business/lists/{listId}
  • Auth: HTTP basic

Path parameters

listIdstring required

24-character hex id of the list (from GET /business/lists).

Query parameters

include'columns'

Set to columns to add the list's custom column definitions (id, name, type) to the response.

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.