Accounts¶

Account¶

The account API, makes use of the term mine. This is an explicit variable to lookup the logged in user account id.

GET /api/v1/account/settings/mine/¶

Returns data on the currently logged in user.

Response

{
    "resource_uri": "/api/v1/account/settings/1/",
    "display_name": "Nice person",
}

To update account information:

PATCH /api/v1/account/settings/mine/¶

Request

Parameters:	display_name (string) – the displayed name for this user.

Response

No content is returned in the response.

Status Codes:	201 – successfully completed.

Fields that can be updated:

• display_name

GET /api/v1/account/installed/mine/¶

Returns a list of the installed apps for the currently logged in user. This ignores any reviewer or developer installed apps.

Request

The standard Listing query params.

Response

Parameters:	meta (object) – Listing response meta. objects (array) – A listing of apps.
Status Codes:	200 – sucessfully completed.

GET /api/v1/account/permissions/mine/¶

Returns a mapping of the permissions for the currently logged in user.

Response

{
    "permissions": {
        "admin": false,
        "developer": false,
        "localizer": false,
        "lookup": true,
        "reviewer": false
    },
    "resource_uri": "/api/v1/account/permissions/1/"
}

Parameters:	permissions (object) – permissions and properties for the user account. It contains boolean values which describe whether the user has the permission described by the key of the field.
Status Codes:	200 – sucessfully completed.

Feedback¶

POST /api/v1/account/feedback/¶

Submit feedback to the Marketplace.

Note

Authentication is optional.

Note

This endpoint is rate-limited at 30 requests per hour per user.

Request

Parameters:	chromeless (string) – (optional) “Yes” or “No”, indicating whether the user agent sending the feedback is chromeless. feedback (string) – (required) the text of the feedback. from_url (string) – (optional) the URL from which the feedback was sent. platform (string) – (optional) a description of the platform from which the feedback is being sent.

{
    "chromeless": "No",
    "feedback": "Here's what I really think.",
    "platform": "Desktop",
    "from_url": "/feedback",
    "sprout": "potato"
}

This form uses PotatoCaptcha, so there must be a field named sprout with the value potato and cannot be a field named tuber with a truthy value.

Response

{
    "chromeless": "No",
    "feedback": "Here's what I really think.",
    "from_url": "/feedback",
    "platform": "Desktop",
    "user": null,
}

Status Codes:	201 – successfully completed. 429 – exceeded rate limit.

Newsletter signup¶

This resource requests that the current user be subscribed to the Marketplace newsletter.

POST /api/v1/account/newsletter/¶

Request

Parameters:	email (string) – The email address to send newsletters to.

Response

Status Codes:	204 – Successfully signed up.