Package ai.vectros.resources.records.requests

Class ListRecordsRequest

java.lang.Object
ai.vectros.resources.records.requests.ListRecordsRequest
public final class ListRecordsRequest extends Object

  • Method Details

    • getType

      public Optional<String> getType()
      Returns:
      The record type to list, e.g. intake_form. Required unless folderId or recent=true is given.

    • getFolderId

      public Optional<String> getFolderId()
      Returns:
      List all records in this folder, regardless of type. The value is a Vectros-assigned folder UUID. Required unless type or recent=true is given; may be combined with type to list a single type within the folder.

    • getUserId

      public Optional<String> getUserId()
      Returns:
      Filter to records owned by this user. The value is the Vectros-assigned UUID of a user; resolve one from your own ID via GET /v1/users?externalId=.

    • getOrgId

      public Optional<String> getOrgId()
      Returns:
      Filter to records owned by this organization. The value is the Vectros-assigned UUID of an organization; resolve one via GET /v1/orgs?externalId=.

    • getClientId

      public Optional<String> getClientId()
      Returns:
      Filter to records owned by this client (requires userId or orgId as well). The value is the Vectros-assigned UUID of a client; resolve one via GET /v1/clients?externalId=.

    • getStartFrom

      public Optional<String> getStartFrom()
      Returns:
      Pagination cursor. Pass the nextCursor returned by the previous page to fetch the next page; omit it for the first page.

    • getLimit

      public Optional<Long> getLimit()
      Returns:
      Maximum number of records to return per page. Allowed range 1–100; defaults to 20.

    • getIncludePayload

      public Optional<String> getIncludePayload()
      Returns:
      Set to true to include each record's full payload in this response, rehydrating any externally stored payloads (hydration is capped per page). Defaults to false, which returns only the indexed projection; fetch a full payload via GET /v1/records/{id}.

    • getRecent

      public Optional<String> getRecent()
      Returns:
      Set to true to return the account-wide recently-updated feed across all record types, newest first — a type-agnostic activity view. This mode is standalone: it ignores type, folderId, and the owner filters. Per-record scope still applies — you see only the record types your token may read.

    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class Object

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • builder

      public static ListRecordsRequest.Builder builder()