Learning Center/API and Integration/API

Roles API

Thomas Pedersen
posted this on February 16, 2010 12:15 am

Each user has a role, which determines the apps available to them.

Show role

Returns a single role.

GET /api/v1/roles/{id}.xml
<role>
  <id>21456</id>
  <name>Marketing</name>
</role>

List all

Returns all roles in one list. The body of each role is the same as for show role.

GET /api/v1/roles.xml
<roles type="array">
  <roles>
    ...
  </roles>
  <roles>
    ...
  </roles>
</roles>