Get Portfolio Group Items

Get all portfolio items in a specific group with pagination and filtering. Items are sorted by created_at in descending order. Supports filtering by date range and business name/ID.

group_idstring uuid required

qstring nullable

The query param. Can be a business name, person name, business_id, person_id, or a type (business or person). If it is a business id or a person id (UUID), it will be used to search by id. If it is a business name or a person name, it will be used to search by name (case-insensitive). If it is a type (business or person), it will be used to search by type. If it is not provided, all portfolio items will be returned.

limitinteger

Maximum number of records to return in a single page. Must be between 1 and 1000.

offsetinteger nullable

Number of records to skip from the beginning. Use 0 for the first page. Cannot be used with cursor.

cursorstring nullable

Opaque pagination cursor token that identifies the position in the result set. Use the cursor from the previous response to get the next page. Cannot be used with offset.

start_datestring date nullable

Filter records created on or after this date (format: YYYY-MM-DD).

end_datestring date nullable

Filter records created on or before this date (format: YYYY-MM-DD).

tzstring

IANA timezone identifier used to interpret start_date and end_date (defaults to UTC).

Example:UTC

IANA timezone identifier used to interpret start_date and end_date (defaults to UTC).

Response

Example response

[
  {
    "search_id": "c623e29e-1f57-11ef-938f-1edb1b067314",
    "user": {
      "first_name": "Austin",
      "last_name": "Taylor",
      "email": "jessicasimpson@example.com"
    },
    "business_id": "ede786f3-33ae-4894-843d-af2025f1d5b0"
  }
]

v1

Get Portfolio Group Items

Path parameters

Query parameters

Response

Example response