Shares

Fetch shares

<!-- theme: info -->

This API is deprecated. Please read our documentation about how to manage access rights.

get/shares

Request

  • Base URL
    https://api.kisi.io
  • URL
    https://api.kisi.io/shares
  • Auth
    • API key in header Authorization
    • or OAuth 2
      Authorization code: https://api.kisi.io/oauth/authorize
      Token URL: https://api.kisi.io/oauth/token

Query parameters

idsstring

Filter by object IDs

querystring

Filter by a freetext string. Properties searched: user.email, user.name

group_idinteger

Filter by group ID

member_idinteger

Filter by member ID

place_idinteger

Filter by place ID

integer
OR
string

Filter by user ID or by current user if value is me.

limitinteger

The number of objects to return

offsetinteger

The number of objects to offset

role_id'basic' | 'manager'

Filter by the role of the share

Response

OK

idinteger required

The ID of the share

resource_type'Share' required

The resource type of the share

created_atstring date-time required

When the share was created

updated_atstring date-time required

When the share was updated

emailstring email required

The email of the share's user. Cannot be changed once set

notifyboolean nullable required

Whether an email should be sent when this share is created or updated

role_id'manager' | 'basic' required

The role of the share

valid_fromstring date-time nullable required

When the share starts to be valid at

valid_untilstring date-time nullable required

When the share stops to be valid at

group_idinteger required

The group ID of the share

member_idinteger required

The member ID of the share

place_idinteger nullable required

The place ID of the share

user_idinteger required

The user ID of the share

created_by_type'null' | 'User' | 'MarketplaceInstallation' nullable required

The created_by type of the share

created_by_idinteger nullable required

The created_by ID of the share

lock_idunknown required
apply_to_placefalse required
rolestring nullable required
issued_to_idinteger nullable required

The ID of the share's user

issued_to_emailstring email required

The email of the share's user

issued_by_idinteger nullable required

The issued_by ID of the share

Changes

No recorded changes to this operation across all 9 revisions of this API.