artifacts

List the sessions, documents, diagrams, and folders in a space, newest first. Set recursive=true to include the spaces under it, and type to list one kind of artifact.

Results are paged by cursor. Each response has data and next_cursor. To get the next page, send next_cursor back as cursor with the same space, type, and recursive. Stop when next_cursor is null. There is no total count, and offset is not supported: a request with offset greater than 0 returns 400. A page can hold fewer than limit items, even none, while next_cursor is still set. This happens when a request checks its maximum number of files without filling the page, so keep paging until next_cursor is null. A cursor is only valid for the listing it came from. Any other cursor returns 400.

Documents, diagrams, and folders are listed only if the API key's user can open them in Auctor, including files shared to them through restrictions and grants. Files the user can't open are left out of data and never take a place on a page. Sessions are not filtered by file role. An M2M token has no user, so it lists only files with no restriction on themselves or on any folder above them.

These file-role checks apply only once file permissions are turned on for your organization. Until then, the list includes every document, diagram, and folder in the space.

Returns 503 if file roles can't be read. Retry the request.

get/v2/artifacts

Request

  • Base URL
    https://api.getauctor.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.getauctor.com/v2/artifacts
  • Auth
    none declared

Query parameters

spacestring required
recursiveboolean
type'session' | 'document' | 'diagram' | 'folder' nullable
limitinteger
cursorstring nullable

next_cursor from the previous page

Response

Successful Response

next_cursorstring nullable required

Pass as cursor to fetch the next page; null when the listing is exhausted.

Changes

    • breaking

      removed the required property from the response with the status

    • warning

      deleted the query request parameter offset

    • info

      added the new optional query request parameter cursor

    • info

      added the required property to the response with the status

    • info

      added the optional property // to the response with the status