Users

Users of the DocumentCloud service.

UserClient

class documentcloud.users.UserClient

The user client gives access to retrieval of users. It is generally accessed as client.users.

all(self, **params)

An alias for list().

get(id_)

Return the user with the provided DocumentCloud identifer.

list(self, **params)

Return a list of all users, possibly filtered by the given parameters. Please see the full API documentation for available parameters.

User

class documentcloud.users.User
avatar_url

A URL pointing to an image representing the user

id

The unique identifer of the user in DocumentCloud’s system. This is a number.

name

The user’s full name.

organization

The ID of the user’s active organization

organizations

A list of IDs of all of the organizations this user is a part of.

username

The user’s username

uuid

A unique identifier used across all of MuckRock’s sites.