invantive documentation
Invantive Support ForumsLog In / Sign Up

PeopleSegmentsByWebsiteId: Crisp People Segments

read only REST

  • Catalog: Crisp
  • Schema: Crisp
  • Label: People Segments

Can only retrieve data.

Summary

One row per segment attributed to a people profile.

API Source

  • Endpoint: /website/{website_id}/people/profiles/{page_number}?per_page=50

Parameters

Name Data Type Required Default Documentation
filter_date_end datetime Retrieve only the people profiles created at or before this moment (UTC).
filter_date_start datetime Retrieve only the people profiles created at or after this moment (UTC).
search_filter varchar2 Search filter as the JSON text the route documents.
search_operator varchar2 Search operator when a search filter is given; and or or, defaults to and.
search_text varchar2 Search term over all people profiles.
sort_field varchar2 Sort the people profiles on this field; one of the available search field names.
sort_order varchar2 Sort order; ascending or descending.
website_id varchar2 The website identifier. Defaults to the website ID of the connection when left out.

Table Columns

The columns of the table PeopleSegmentsByWebsiteId are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.

Name Data Type Label Required Marks Documentation
email varchar2 itgen_crp_email filters on the platform, writable, ::ancestor.email Email for people profile.
people_id varchar2 itgen_crp_people_id filters on the platform, writable, ::ancestor.people_id People identifier.
person_created_at datetime itgen_crp_person_created_at filters on the platform, writable, ::ancestor.created_at Profile creation timestamp.
person_updated_at datetime itgen_crp_person_updated_at filters on the platform, writable, ::ancestor.updated_at Profile update timestamp.
segment varchar2 itgen_crp_segment filters on the platform, writable, ::self Segment attributed to the people profile.

Keys

Key Column Refers to Kind Description
PeopleSegmentsByWebsiteId_people_id_cnd people_id PeopleProfilesByWebsiteId.people_id Candidate Follows from the name of the column and held in the data of the smoke website on 2026-10-31; not stated by Crisp.

Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver: