Skip to main content

User Profiles


AnchorOverview

In addition to the primary GraphQL endpoint, which is scoped to a particular user, Quiltt provides a set of REST endpoints for global user management and administration.

A profile represents the information about a user in your Quiltt environment.

Authorization

Pass in your App Secret in the Authorization HTTP header:

Authorization: Bearer {{APP_SECRET}}

AnchorCreate profile

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

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

Body

{
"email": "elon@musk.com",
"name": "Elon Musk",
"phone": "+12125550180",
"metadata": {
"favorite_mode": "plaid"
}
}

Response - 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"
}

AnchorGet a profile

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

Get a specific user’s profile.

Response - 200 OK

{
"userId": "3b382d41-1dba-4669-b537-44b2e5049aa7",
"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.

Body

{
"email": "elon@tesla.com",
"name": "Elon Musk",
"phone": "+12125550180",
"metadata": {
"favoritePlanet": "Mars"
}
}

Response - 200 OK

{
"id": "1df80004-c24a-478c-ada1-d950716c77b9",
"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.

Response - 204 No Content


AnchorList all profiles

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

Get a list of all your user profiles.

Response - 200 OK

[
{
"userId": "da4d6590-041d-47f5-aed8-6a447a0ac620",
"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": "We are hiring!",
"phone": null,
"email": "team@quiltt.io",
"metadata": null,
"createdAt": "2021-03-04T07:47:44.891Z",
"updatedAt": "2021-03-24T22:32:45.328Z"
}
]