User Profiles
User Profiles represent the information about users in your Quiltt environment.
Link to this section#Schemas
| Field | Type | Description |
|---|---|---|
id | stringrequired | The ID of the Profile. |
uuid | stringrequired | The UUID of the Profile |
userId | string | Use `id` instead |
email | stringrequired | The email associated with the Profile. This field can be used to power passwordless authentication in the Connector. |
phone | stringrequired | The phone number associated with the Profile. This field can be used to power passwordless authentication in the Connector. |
name | stringrequired | The name of the Profile. |
names | objectrequired | A physical person's legal name. |
dateOfBirth | stringrequired | A physical person's date of birth. |
address | objectrequired | The Profile's address. |
metadata | objectrequired | Custom metadata about the Profile, stored in a 'key-value' format. See the [Custom Metadata](https://quiltt.dev/guides/custom-metadata) guide for more information and examples. |
createdAt | stringrequired | The date and time (ISO 8601 format) when the Profile was created. |
updatedAt | stringrequired | The date and time (ISO 8601 format) when the Profile was last updated. |
Link to this section#Create a Profile
POSThttps://api.quiltt.io/v1/profilesCreate a new user Profile, assigning profile attributes, if provided.
Link to this section#Request Parameters
<UserProfileAttrs />
Link to this section#Request Example
<HttpSnippet request={createProfile} target="server-side" />
Link to this section#Response Example
Link to this section#201 Created
Link to this section#Retrieve a Profile
<EndPointUrl method="GET" base="https://api.quiltt.io" endpoint="/v1/profiles/:id" />
Get a specific user's Profile.
Link to this section#Request Example
<HttpSnippet request={getProfile} target="server-side" />
Link to this section#Response Example
Link to this section#200 OK
Link to this section#Update a Profile
<EndPointUrl method="PUT" base="https://api.quiltt.io" endpoint="/v1/profiles/:id" />
Update a specific user's Profile.
Link to this section#Request Parameters
<UserProfileAttrs />
Link to this section#Request Example
<HttpSnippet request={updateProfile} target="server-side" />
Link to this section#Response Example
Link to this section#200 OK
Link to this section#Delete a Profile
<EndPointUrl method="DELETE" base="https://api.quiltt.io" endpoint="/v1/profiles/:id" />
Delete a specific user's Profile. This request will also delete their associated data and disable any Quiltt-managed Connections.
Link to this section#Request Example
<HttpSnippet request={deleteProfile} target="server-side" />
Link to this section#Response Example
Link to this section#204 No Content
Link to this section#List all Profiles
<EndPointUrl method="GET" base="https://api.quiltt.io" endpoint="/v1/profiles" />
Get a paginated list of all your user profiles.
Link to this section#Request Example
<HttpSnippet request={listProfiles} target="server-side" />