Vizzlo Organizations & Teams

Retrieving organizations

Route

GET /api/v1/orgs/org

Managing organization settings

Route

PATCH /api/v1/orgs/org

This method can be used to update certain organization-specific settings. Currently, the following values can be updated using PATCH calls with query parameters:

  • default_theme: Specifies the default theme to use when a user that is members of this organization creates a new document. This setting shall be provided as string that identifies the theme—potentially including the organization’s slug.
Example
curl -u USER:PASSWORD --request PATCH --data default_theme=vizzlo/orange https://vizzlo.com/api/v1/orgs/vizzlo

Managing organization members

Listing members of an organization

Route

GET /api/v1/orgs/org/members

Adding members to an organization

Route

POST /api/v1/orgs/org/members/add

Removing members from an organization

Route

POST /api/v1/orgs/org/members/remove

Marking a member as organization owner

Routes
  • POST /api/v1/orgs/org/members/promote-owner

  • POST /api/v1/orgs/org/members/demote-owner

Managing organization themes

Routes
  • GET /api/v1/orgs/org/themes

  • GET /api/v1/orgs/org/themes/theme

  • PUT /api/v1/orgs/org/themes/theme

  • DELETE /api/v1/orgs/org/themes/theme

Managing organization assets

Listing assets

Route

GET /api/v1/orgs/org/assets

Example
curl -u USER:PASSWORD https://vizzlo.com/api/v1/orgs/vizzlo/assets

Add or updating organization assets

Routes
  • PUT /api/v1/orgs/org/assets/filename

  • POST /api/v1/orgs/org/assets

Deleting assets

DELETE /api/v1/orgs/org/assets/filename

Example
curl -u USER:PASSWORD -X DELETE https://vizzlo.com/api/v1/orgs/vizzlo/assets/FILENAME

Managing Teams

Listing all teams of an organization

Route

GET /api/v1/orgs/org/teams

Creating a new team

Route

POST /api/v1/orgs/org/teams

Getting information about a specific team

Route

GET /api/v1/orgs/org/team/team

Adding/Removing members of a team

Routes

PUT /api/v1/orgs/org/team/team/member/username

DELETE /api/v1/orgs/org/team/team/member/username

Updating information of a specific team

Route

PUT /api/v1/orgs/org/team/team

Deleting a team

Route

DELETE /api/v1/orgs/org/team/team