Back to DropboxPaper - Docs - Users - List - Continue
Once a cursor has been retrieved from :route:docs/users/list
, use this to paginate through all users on the Paper doc.
Input
type: object
properties:
data:
type: object
description: >
doc_id: The Paper doc ID.
cursor: The cursor obtained from :route:`docs/users/list` or
:route:`docs/users/list/continue`. Allows for pagination.
properties:
cursor:
type: string
description: >-
The cursor obtained from :route:`docs/users/list` or
:route:`docs/users/list/continue`. Allows for pagination.
doc_id:
type: string
description: The Paper doc ID.
title: Data
Output
type: object
description: >
invitees: List of email addresses with their respective permission levels that
are invited on the Paper doc.
users: List of users with their respective permission levels that are invited
on the Paper folder.
doc_owner: The Paper doc owner. This field is populated on every single
response.
cursor: Pass the cursor into :route:`docs/users/list/continue` to paginate
through all users. The cursor preserves all properties as specified in the
original call to :route:`docs/users/list`.
has_more: Will be set to True if a subsequent call with the provided cursor to
:route:`docs/users/list/continue` returns immediately with some results. If
set to False please allow some delay before making another call to
:route:`docs/users/list/continue`.
properties:
cursor:
type: object
description: >
value: The actual cursor value.
expiration: Expiration time of :field:`value`.
Some cursors might have expiration time assigned. This is a UTC value
after which the cursor is no longer valid and the API starts returning an
error. If cursor expires a new one needs to be obtained and pagination
needs to be restarted. Some cursors might be short-lived some cursors
might be long-lived.
This really depends on the sorting type and order, e.g.:
1. on one hand, listing docs created by the user, sorted by the created
time ascending will have undefinite expiration because the results cannot
change while the iteration is happening. This cursor would be suitable for
long term polling.
2. on the other hand, listing docs sorted by the last modified time will
have a very short expiration as docs do get modified very often and the
modified time can be changed while the iteration is happening thus
altering the results.
properties:
expiration:
type: string
description: >-
Expiration time of :field:`value`.
Some cursors might have expiration time assigned. This is a UTC value
after which the cursor is no longer valid and the API starts returning
an error. If cursor expires a new one needs to be obtained and
pagination needs to be restarted. Some cursors might be short-lived
some cursors might be long-lived.
This really depends on the sorting type and order, e.g.:
1. on one hand, listing docs created by the user, sorted by the
created time ascending will have undefinite expiration because the
results cannot change while the iteration is happening. This cursor
would be suitable for long term polling.
2. on the other hand, listing docs sorted by the last modified time
will have a very short expiration as docs do get modified very often
and the modified time can be changed while the iteration is happening
thus altering the results.
value:
type: string
description: The actual cursor value.
has_more:
type: boolean
description: >-
Will be set to True if a subsequent call with the provided cursor to
:route:`docs/users/list/continue` returns immediately with some results.
If set to False please allow some delay before making another call to
:route:`docs/users/list/continue`.
doc_owner:
type: object
description: >
Basic information about a user. Use :route:`users.get_account` and
:route:`users.get_account_batch` to obtain more detailed information.
account_id: The account ID of the user.
email: Email address of user.
display_name: The display name of the user.
same_team: If the user is in the same team as current user.
team_member_id: The team member ID of the shared folder member. Only
present if :field:`same_team` is true.
properties:
email:
type: string
description: Email address of user.
team_member_id:
type: string
description: >-
The team member ID of the shared folder member. Only present if
:field:`same_team` is true.
display_name:
type: string
description: The display name of the user.
account_id:
type: string
description: The account ID of the user.
same_team:
type: boolean
description: If the user is in the same team as current user.
users:
type: array
description: >-
List of users with their respective permission levels that are invited on
the Paper folder.
items:
type: object
description: |
user: User shared on the Paper doc.
permission_level: Permission level for the user.
properties:
permission_level:
type: object
description: |
edit: User will be granted edit permissions.
view_and_comment: User will be granted view and comment permissions.
other: None
properties:
.tag:
title: Choice of PaperDocPermissionLevel
type: string
enum:
- edit
- view_and_comment
- other
user:
type: object
description: >
Basic information about a user. Use :route:`users.get_account` and
:route:`users.get_account_batch` to obtain more detailed
information.
account_id: The account ID of the user.
email: Email address of user.
display_name: The display name of the user.
same_team: If the user is in the same team as current user.
team_member_id: The team member ID of the shared folder member. Only
present if :field:`same_team` is true.
properties:
email:
type: string
description: Email address of user.
team_member_id:
type: string
description: >-
The team member ID of the shared folder member. Only present if
:field:`same_team` is true.
display_name:
type: string
description: The display name of the user.
account_id:
type: string
description: The account ID of the user.
same_team:
type: boolean
description: If the user is in the same team as current user.
invitees:
type: array
description: >-
List of email addresses with their respective permission levels that are
invited on the Paper doc.
items:
type: object
description: |
invitee: Email address invited to the Paper doc.
permission_level: Permission level for the invitee.
properties:
permission_level:
type: object
description: |
edit: User will be granted edit permissions.
view_and_comment: User will be granted view and comment permissions.
other: None
properties:
.tag:
title: Choice of PaperDocPermissionLevel
type: string
enum:
- edit
- view_and_comment
- other
invitee:
type: object
description: |
Information about the recipient of a shared content invitation.
email: E-mail address of invited user.
other: None
properties:
.tag:
title: Choice of InviteeInfo
type: string
enum:
- email
- other
email:
type: string
description: E-mail address of invited user.