Skip to main content

User Profiles

AnchorOverview

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

AnchorSchemas

User Profile

userId string
UUID
name string
phone string
E.164 Format
email string
createdAt string
updatedAt string
metadata object

AnchorCreate a Profile

POST
https://api.quiltt.io/v1/profiles

Create a new user Profile, assigning profile attributes, if provided.

AnchorRequest Parameters

name string
phone string
Must be in E.164 Format
email string
metadata object

AnchorRequest Example

AnchorResponse Example

201 Created

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

AnchorRetrieve a Profile

GET
https://api.quiltt.io/v1/profiles/:userId

Get a specific user’s Profile.

AnchorRequest Example

AnchorResponse Example

200 OK

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

AnchorUpdate a Profile

PUT
https://api.quiltt.io/v1/profiles/:userId

Update a specific user’s Profile.

AnchorRequest Parameters

name string
phone string
Must be in E.164 Format
email string
metadata object

AnchorRequest Example

AnchorResponse Example

200 OK

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

AnchorDelete a Profile

DELETE
https://api.quiltt.io/v1/profiles/:userId

Delete a specific user’s Profile. This request will also delete their associated data and disable any Quiltt-managed Connections.

AnchorRequest Example

AnchorResponse Example

204 No Content

AnchorList all Profiles

GET
https://api.quiltt.io/v1/profiles

Get a paginated list of all your user profiles.

AnchorRequest Example

AnchorResponse Example

200 OK

[
  {
    "userId": "4dcd323c-dac6-4450-9be6-56f63fa02ef4",
    "name": "Elon Musk",
    "phone": null,
    "email": "elon@musk.com",
    "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": "careers@quiltt.io",
    "metadata": null,
    "createdAt": "2021-03-04T07:47:44.891Z",
    "updatedAt": "2021-03-24T22:32:45.328Z"
  }
]
REST APIAuthentication