Developers
API referenceReferenceUser

Current User - Update

Update the currently authenticated user profile. This endpoint is always scoped to the caller and does not accept a user ID.

PATCH
/v1/user/

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PATCH "https://example.com/v1/user/" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": 0,  "email": "user@example.com",  "first_name": "string",  "last_name": "string",  "last_login": "2019-08-24T14:15:22Z",  "date_joined": "2019-08-24T14:15:22Z",  "tos_accepted": true,  "tos_accepted_by_market": {    "property1": true,    "property2": true  },  "saltedge_tos_accepted_at": "2019-08-24T14:15:22Z",  "last_csat": "2019-08-24T14:15:22Z",  "invitations": [    {      "id": 0,      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "email": "user@example.com",      "status": "OPEN",      "permissions": [        "admin"      ],      "permission_group": "admin",      "tags": [        "entrepreneur"      ]    }  ],  "notifications": null,  "avatar_url": "string",  "userships": [    {      "id": 0,      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "user": 0,      "business": 0,      "business_id": "string",      "permissions": {        "admin": {          "name": "string",          "value": true,          "explanation": "string"        },        "bookkeeping_read": {          "name": "string",          "value": true,          "explanation": "string"        },        "bookkeeping_admin": {          "name": "string",          "value": true,          "explanation": "string"        },        "bookkeeping_editor": {          "name": "string",          "value": true,          "explanation": "string"        },        "bookkeeping_attachment": {          "name": "string",          "value": true,          "explanation": "string"        },        "accounts_read": {          "name": "string",          "value": true,          "explanation": "string"        },        "accounts_editor": {          "name": "string",          "value": true,          "explanation": "string"        },        "files_read": {          "name": "string",          "value": true,          "explanation": "string"        },        "files_editor": {          "name": "string",          "value": true,          "explanation": "string"        },        "invoicing_read": {          "name": "string",          "value": true,          "explanation": "string"        },        "invoicing_admin": {          "name": "string",          "value": true,          "explanation": "string"        },        "invoicing_editor": {          "name": "string",          "value": true,          "explanation": "string"        },        "contact_read": {          "name": "string",          "value": true,          "explanation": "string"        },        "contact_editor": {          "name": "string",          "value": true,          "explanation": "string"        },        "reporting_read": {          "name": "string",          "value": true,          "explanation": "string"        },        "reporting_admin": {          "name": "string",          "value": true,          "explanation": "string"        },        "reporting_editor": {          "name": "string",          "value": true,          "explanation": "string"        },        "salary": {          "name": "string",          "value": true,          "explanation": "string"        },        "integration_admin": {          "name": "string",          "value": true,          "explanation": "string"        }      }    }  ],  "show_get_started_info": true,  "language": "fi",  "last_active_business_id": "string",  "last_active_business_slug": "string",  "subscription_tier": "string",  "has_tos_acceptance_record": true,  "agency_id": 0,  "is_agency_user": true,  "agency_role": "string",  "is_agency_admin": true,  "credit_cap": 0,  "agency_name": "string",  "ui_preferences": null}

Current User - Retrieve GET

Retrieve the currently authenticated user profile. This endpoint is always scoped to the caller and does not accept a user ID.

Current User - Replace PUT

Replace the currently authenticated user profile (full body). This endpoint is always scoped to the caller and does not accept a user ID.