The Collaborator Object

This is an object representing collaborators in a space. Some properties can be read-only, and others can be managed by the space owner using the Management API. You can define the properties of a collaborator, such as roles and permissions.

You can learn more about permissions and roles for collaborators in the Space Roles endpoint.

Properties

user
object

The user object inside a collaborator object
- id
  number
  
  The user ID
- firstname
  string
  
  First name of collaborator
- lastname
  string
  
  Last name of collaborator
- alt_email
  string
  
  Email of collaborator
- avatar
  string
  
  Avatar of collaborator usually an image
- userid
  string
  
  User ID of collaborator
- friendly_name
  string
  
  Friendly name of collaborator
role
string

Role of the collaborator, could be admin, editor or custom roles
user_id
number

Numeric ID of the user

permissions

enum[]

Allow specific actions for collaborator in interface and add the permission as array of strings

Permission	Description
publish_stories	Allow publishing of content entries
save_stories	Allow editing and saving of content entries
edit_datasources	Allow editing and saving of datasources
access_commerce	Allow access to commerce app
edit_story_slug	Deny the change of slugs of content entries
move_story	Deny moving of content entries
view_composer	Deny access to visual composer

allowed_paths
number[]

Story ids the user should have access to (acts as whitelist). If no item is selected the user has rights to access all content items.
field_permissions
string[]

Hide specific fields for this user with an array of strings with the schema
id
number

Numeric id of collaborator
space_role_id
number

Numeric id of the space role connected with collaborators
space_role_ids
number[]

Array of space role ids
space_id
number

Numeric id of the collaborator space

Example Object

{
   "collaborators":[
      {
         "user":{
            "id":262115,
            "firstname":"Marve",
            "lastname":"Priscy",
            "alt_email":null,
            "avatar": "avatars/115866/5fgecfcb64/mayve.jpeg",
            "userid":"mayve@email.com",
            "friendly_name":"Marve Priscy"
         },
         "role":"49708",
         "user_id":262115,
         "permissions":["can_subscribe"],
         "allowed_path":"",
         "field_permissions":"",
         "id":236290,
         "space_role_id":"49708",
         "invitation":null,
         "space_role_ids":[],
         "space_id":866112
      }
   ]
}

Prev Introduction

Next Retrieve Multiple Collaborators