Quiltt Logo

User Profiles

User Profiles represent the information about users in your Quiltt environment.

Link to this section#Schemas

Link to this section#User Profile

FieldType
userIdString (uuid)
nameString
phoneString (E.164 Format)
emailString
createdAtString (Date)
updatedAtString (Date)
metadataObject

Link to this section#Create a Profile

POSThttps://api.quiltt.io/v1/profiles

Create 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

{ "userId": "4dcd323c-dac6-4450-9be6-56f63fa02ef4", "name": "Elon Musk", "phone": "+12125550180", "email": "[email protected]", "metadata": { "favoriteMode": "plaid" }, "createdAt": "2021-07-08T22:54:13.549Z", "updatedAt": "2021-07-08T22:54:13.549Z" }

Link to this section#Retrieve a Profile

<EndPointUrl method="GET" base="https://api.quiltt.io" endpoint="/v1/profiles/:userId" />

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

{ "userId": "4dcd323c-dac6-4450-9be6-56f63fa02ef4", "name": "Elon Musk", "phone": "+12125550180", "email": "[email protected]", "metadata": { "favoriteMode": "plaid" }, "createdAt": "2021-03-02T21:09:51.758Z", "updatedAt": "2021-03-02T21:09:51.758Z" }

Link to this section#Update a Profile

<EndPointUrl method="PUT" base="https://api.quiltt.io" endpoint="/v1/profiles/:userId" />

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

{ "id": "4dcd323c-dac6-4450-9be6-56f63fa02ef4", "name": "Elon Musk", "phone": null, "email": "[email protected]", "metadata": { "favoriteMode": "plaid", "favoritePlanet": "Mars" }, "createdAt": "2021-05-13T05:27:00.245Z", "updatedAt": "2021-05-13T05:27:00.245Z" }

Link to this section#Delete a Profile

<EndPointUrl method="DELETE" base="https://api.quiltt.io" endpoint="/v1/profiles/:userId" />

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" />

Link to this section#Response Example

Link to this section#200 OK

[ { "userId": "4dcd323c-dac6-4450-9be6-56f63fa02ef4", "name": "Elon Musk", "phone": null, "email": "[email protected]", "metadata": { "favoriteMode": "plaid" }, "createdAt": "2021-03-04T19:02:43.000Z", "updatedAt": "2021-03-04T19:02:43.000Z" }, { "userId": "267293a6-9b0e-4216-bfca-2364edaa894e", "name": "Quiltt is hiring!", "phone": null, "email": "[email protected]", "metadata": null, "createdAt": "2021-03-04T07:47:44.891Z", "updatedAt": "2021-03-24T22:32:45.328Z" } ]