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=.

    • getScope

      public Optional<String> getScope()
      Returns:
      Filter to records carrying this scope value, in namespace:value form (a value is 1-128 chars: a letter or digit first, then letters, digits, _ or -) — for example group:eng-team, org:<id>, or client:<id>. Resolve an entity's UUID from your own identifier via GET /v1/entities/{namespace}?externalId=. Combine with type or folderId.

    • 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. The cursor is opaque — echo it back unchanged, and do not parse it or construct one. Keep every other query parameter identical while paging: a cursor is valid only for the exact query that returned it, and reusing one against a different query is rejected with a 400.

    • 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()