User API Overview¶
Use the User API to view and update account and preference information.
User API Version and Status¶
The User API is currently at version 1.0. We plan on making significant enhancements to this API.
User API Resources and Endpoints¶
The User API supports the following resources, tasks, methods, and endpoints.
User Accounts API Resource¶
Task | Method | Endpoint |
---|---|---|
Get a user’s account information | GET | /api/user/v1/accounts/{username}/[?view=shared] |
Update your account information | PATCH | /api/user/v1/accounts/{username}/{“key”:”value”} |
User Preferences API Resource¶
Task | Method | Endpoint |
---|---|---|
Get a user’s preferences information | GET | /api/user/v1/preferences/{username}/ |
Update a user’s preferences information | PATCH | /api/user/v1/preferences/{username}/ |
Get a specific preference | GET | /api/user/v1/preferences/{username}/{preference_key} |
Update a specific preference | PUT | /api/user/v1/preferences/{username}/{preference_key} |
Delete a specific preference | DELETE | /api/user/v1/preferences/{username}/{preference_key} |