Skip to main content
GET
Returns source records in the workspace tied to your API key, ordered by updatedAt descending then externalId descending by default. Set order=asc to reverse the order. Use it to enumerate sources, inspect ingestion status, and find source IDs to pass back to Ingest sources.
For the end-to-end model, see Sources. For async polling guidance, see Ingest sources.
The response field is still named documents because that is the current API contract. On this page, each entry is described as a source record.

Headers

string
required
Bearer token containing your Fini workspace API key. Format: Bearer fini_...

Query parameters

integer
default:"50"
Maximum number of source records to return.
string
Source ID to paginate from. Use the last source’s id from the previous response to fetch the next page, or the first source’s id to fetch the previous page.
string
default:"next"
Pagination direction when a cursor is supplied. Note the inverted mapping: next moves toward older sources; previous moves back toward newer ones. This is because results are sorted by updatedAt descending.
string
default:"desc"
Sort direction for updatedAt, followed by externalId. Accepted values: asc, desc.
string
Optional source-type filter. Supported values: web, files, googledrive, zendesk, notion, confluence.
boolean
Optional English-processing filter.
array
Filter by ingestion outcome. Pass true for successful sources or false for failed sources. This is an array-valued query parameter.
string
Exact source ID filter.
string
Case-insensitive partial match on the source title.
string
Case-insensitive partial match on the original source URL.
string
Filter web sources by exact hostname, for example docs.example.com. This parameter is valid only when source=web.
string
Filter by linked article or knowledge node ID.
array
Pass true to return sources linked to a knowledge article or false to return sources without one. Supplying both values disables this filter.
string
Filter by linked knowledge operation. Supported values: ADD_ARTICLE_TO_FOLDER, UPDATE_ARTICLE, DO_NOTHING.
boolean
Return only linked sources flagged as changed. This is the key filter for the source-refresh workflow before Bulk generate knowledge.
The response includes hasMore but not a nextCursor field. Use the last or first source id from the returned array as the cursor for the next call.

Response

array
Array of Document objects.
boolean
Whether more results exist beyond the current page.

Nested objects

Document

Document is the wire-format object returned by the sources read routes. In the product model, each Document is one source record.
string
Source ID. Also used as the pagination cursor.
string
Original provider URL or web link.
string
Source title.
string | null
Internal storage URL when the source has been uploaded into Fini’s storage layer.
string
ID of the workspace that owns the source.
string
Source type. One of web, files, googledrive, notion, zendesk, or confluence.
string
Provider-specific external identifier, or the URL itself for web.
boolean
Whether English processing is enabled for the source.
boolean
Whether BASER processing is enabled for the source.
boolean
Whether the latest ingestion or refresh run succeeded.
string
Latest processing error, if any. Empty string when the last run succeeded.
string
ISO 8601 creation timestamp.
string
ISO 8601 last-update timestamp. Used as the sort key.
string
Source MIME type.
string | null
Provider-specific type, when available, for example Notion page.
string | null
Linked article or knowledge node ID, if this source has already been turned into knowledge.
string | null
Operation used when the source last linked into knowledge. One of ADD_ARTICLE_TO_FOLDER, UPDATE_ARTICLE, DO_NOTHING.
string | null
Additional reason metadata for the linked operation, when present.
string | null
Background job ID for the latest queued ingest or refresh.
string | null
Background job status. One of PENDING, IN_PROGRESS, COMPLETED, FAILED.
boolean
Whether the latest refresh detected a meaningful change compared with the previously linked content. This is the key field for the source-refresh workflow.
array
Extracted paragraph payload, if the source has been processed. Can be large. Use Get source when you need one source and want a focused payload.
array
Previous paragraph snapshot used for change detection, when available.

Pagination

Cursor pagination uses source IDs directly:
  • pass the last source’s id from the previous response with direction=next to move toward older sources
  • pass the first source’s id with direction=previous to move back toward newer sources
If you omit cursor, the API starts from the most recently updated sources.

Errors

Query parameters are invalid. Common causes: unsupported source value, unsupported linkedOperation value, malformed UUID in id or articleId.
The API key is missing, malformed, revoked, or invalid. Confirm Authorization: Bearer fini_... with the full key.
The API key doesn’t include the read scope, or it’s scoped to a different workspace.
Either the workspace has no sources matching your filters, or no sources at all. Drop filters one at a time to confirm which one is excluding results.