Add-on Authors

Note

These APIs are not frozen and can change at any time without warning. See the API versions available for alternatives if you need stability - note the following APIs are only available on v5+ though.

Author List

This endpoint returns a list of all the authors of an add-on. No pagination is supported. New authors are created as pending authors, which become authors once the user has confirmed.

Note

This API requires authentication, and for the user to be an author of the add-on.

GET /api/v5/addons/addon/(int:id|string:slug|string:guid)/authors/

Author Detail

This endpoint allows the properties of an add-on author to be retrieved, given a user (account) id.

Note

This API requires authentication, and for the user to be an author of the add-on.

GET /api/v5/addons/addon/(int:id|string:slug|string:guid)/authors/(int: user_id)/
Response JSON Object:

  • user_id (int) – The user id for an author.

  • name (string) – The name for an author.

  • email (string) – The email address for an author.

  • role (string) – The role the author holds on this add-on.

  • listed (boolean) – If true the user will be listed as an add-on author publicly on the add-on detail page. (If false the user is not exposed as an author.)

  • position (int) – The position the author should be returned in the list of authors of the add-on detail. Order is ascending so lower positions are placed earlier.

Possible values for the role field:

Value

Description

developer

A developer of the add-on. Developers can change all add-on metadata and create, delete, and edit versions of the add-on.

owner

An owner of the add-on. Owners have all the abilities of a developer, plus they can add, remove, and edit add-on authors, and delete the add-on.

Author Edit

This endpoint allows the properties of an add-on author to be edited.

Note

This API requires authentication, and for the user to be an owner of the add-on.

Warning

If you change your own author role to developer from owner you will lose permission to make any further author changes.

PATCH /api/v5/addons/addon/(int:addon_id|string:addon_slug|string:addon_guid)/authors/(int: user_id)/
Request JSON Object:

  • role (string) – The role the author holds on this add-on. Add-ons must have at least one owner author.

  • listed (boolean) – If true the user will be listed as an add-on author publicly on the add-on detail page. (If false the user is not exposed as an author.) Add-ons must have at least one listed author.

  • position (int) – The position the author should be returned in the list of authors of the add-on detail. Order is ascending so lower positions are placed earlier.

Author Delete

This endpoint allows an add-on author to be removed from an add-on. Add-ons must have at least one owner, and at least one listed author.

Note

This API requires authentication, and for the user to be an owner of the add-on.

Warning

If you delete yourself as an add-on author you will lose all access to the add-on.

DELETE /api/v5/addons/addon/(int:addon_id|string:addon_slug|string:addon_guid)/authors/(int: user_id)/

Pending Author Create

This endpoint allows an owner to invite a user to become an author of an add-on - the user will be sent an email notifying them of the invitation. A pending author is created for the add-on, and once they confirm the invitation, they will be an author of that add-on. Authors will be given the position at the end of the list of authors when confirmed.

Note

This API requires authentication, and for the user to be an owner of the add-on.

POST /api/v5/addons/addon/(int:addon_id|string:addon_slug|string:addon_guid)/pending-authors/
Request JSON Object:

  • user_id (int) – The user to invited to become an author of this add-on.

  • role (string) – The role the author will hold on this add-on.

  • listed (boolean) – If true the user will be listed as an add-on author publicly on the add-on detail page once confirmed. (If false the user will not be exposed as an author.)

Pending Author Confirm

This endpoint allows a user to confirm they want to be an author of an add-on. Authors will be given the position at the end of the list of authors when confirmed.

Note

This API requires authentication, and for the user to be invited to be an author (to be a pending author).

POST /api/v5/addons/addon/(int:addon_id|string:addon_slug|string:addon_guid)/pending-authors/confirm/

Pending Author Decline

This endpoint allows a user to decline the invitation to be an author of an add-on.

Note

This API requires authentication, and for the user to be invited to be an author (to be a pending author).

POST /api/v5/addons/addon/(int:addon_id|string:addon_slug|string:addon_guid)/pending-authors/decline/

Pending Author List

This endpoint returns a list of all the pending authors of an add-on. No pagination is supported.

Note

This API requires authentication, and for the user to be an author of the add-on.

GET /api/v5/addons/addon/(int:id|string:slug|string:guid)/pending-authors/

Pending Author Detail

This endpoint allows the properties of a pending add-on author to be retrieved, given a user (account) id.

Note

This API requires authentication, and for the user to be an author of the add-on.

GET /api/v5/addons/addon/(int:id|string:slug|string:guid)/pending-authors/(int: user_id)/
Response JSON Object:

  • user_id (int) – The user id for a pending author.

  • name (string) – The name for a pending author.

  • email (string) – The email address for a pending author.

  • role (string) – The role the author will hold on this add-on.

  • listed (boolean) – If true the user will be listed as an add-on author publicly on the add-on detail page once confirmed. (If false the user will not be exposed as an author.)

Pending Author Edit

This endpoint allows the properties of a pending add-on author to be edited.

Note

This API requires authentication, and for the user to be an owner of the add-on.

PATCH /api/v5/addons/addon/(int:addon_id|string:addon_slug|string:addon_guid)/pending-authors/(int: user_id)/
Request JSON Object:

  • role (string) – The role the author will hold on this add-on.

  • listed (boolean) – If true the user will be listed as an add-on author publicly on the add-on detail page once confirmed. (If false the user will not be exposed as an author.)

Pending Author Delete

This endpoint allows a pending add-on author to be deleted, so the user is no longer able to confirm to become an author of the add-on.

Note

This API requires authentication, and for the user to be an owner of the add-on.

DELETE /api/v5/addons/addon/(int:addon_id|string:addon_slug|string:addon_guid)/pending-authors/(int: user_id)/