The Collaborator Object

An object that represents a collaborator in a space. You can assign the collaborator to a role, retrieve permissions, update their details, and more.

Learn more about roles and permissions in the Space Roles endpoint.

Properties

• user object

  The user object inside a collaborator object.

  Show child properties

  • id number

    Numeric ID of a user.

  • firstname string

    First name of a collaborator.

  • lastname string

    Last name of a collaborator.

  • alt_email string

    Alternative email of a collaborator.

  • disabled boolean

    Whether the collaborator is active or not.

  • avatar string

    Avatar of a collaborator (usually an image file).

  • userid string

    User ID of a collaborator.

  • friendly_name string

    Friendly name of a collaborator.

  • real_email string

    Email of a collaborator.

• role string

  Role of a collaborator. Can be admin, editor, or custom roles.

• user_id number

  Numeric ID of a user.

• permissions enum[]

  An array of strings that define the role’s permissions.

  Tip

  Find the full list of permissions in the space role object reference page.

  Permission	Description
  read_stories	Read-only access to stories
  save_stories	Edit and save stories
  publish_stories	Publish stories
  unpublish_stories	Unpublish stories
  publish_folders	Publish folders (including stories contained within)
  unpublish_folders	Unpublish folders (including stories contained within)
  deploy_stories	Deploy pipeline stories
  delete_stories	Permanently delete stories
  edit_image	Edit images in the Image Editor
  view_composer	Use the Visual Editor
  change_alternate_group	Change alternate content groupings (for internationalization or variants)
  move_story	Move stories between folders
  edit_story_slug	Edit a story URL
  view_content	If checked, hides all stories except those defined in allowed_paths (Permissions → Content → Folder/Content item permissions)
  view_folders	If checked, hides all folders except those defined in allowed_paths (Permissions → Content → Folder/Content item permissions)
  view_draft_json	View the draft JSON payload of stories
  view_published_json	View the published JSON payload of stories
  manage_tags	Create, edit, or delete tags
  edit_datasources	Edit datasources
  edit_datasource_keys	Edit datasources keys
  access_commerce	Access e-commerce features (if available)
  manage_block_library	Create, move, and edit blocks and folders
  hide_asset_folders	If checked, hides all assets and folders except those defined in asset_folder_ids (Permissions → Assets → Asset Folder Permissions)

• allowed_path number[]

  An array of story IDs that the role can access. If none is selected, all stories are accessible.

• field_permissions string[]

  An array of fields hidden from this role (based on the block schema). If none is selected, all fields are visible.

• id number

  Numeric ID of a collaborator.

• space_role_id number

  Numeric ID associated with a single custom role.

• space_role_ids number[]

  An array of numeric IDs associated with each custom role assigned to a single collaborator.

• space_id number

  Numeric ID of the collaborator’s space.

Example Object

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