Skip to content

Users

This is a module containing: Monday query_users* tasks

query_users(monday_credentials, ids=None, kind=None, newest_first=None, limit=None, emails=None, return_fields=None) async

Get your data from monday.com.

Parameters:

Name Type Description Default
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
ids Iterable[int]

A list of users unique identifiers.

None
kind UserKind

The kind to search users by (all / non_guests / guests / non_pending).

None
newest_first bool

Get the recently created users at the top of the list.

None
limit int

Number of users to get.

None
emails Iterable[str]

A list of users emails.

None
return_fields Iterable[str]

Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/users.py
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
@task
async def query_users(
    monday_credentials: MondayCredentials,
    ids: Iterable[int] = None,
    kind: graphql_schema.UserKind = None,
    newest_first: bool = None,
    limit: int = None,
    emails: Iterable[str] = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Get your data from monday.com.

    Args:
        monday_credentials: Credentials to use for authentication with Monday.
        ids: A list of users unique identifiers.
        kind: The kind to search users by (all / non_guests / guests /
            non_pending).
        newest_first: Get the recently created users at the top of the list.
        limit: Number of users to get.
        emails: A list of users emails.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.users(
        **strip_kwargs(
            ids=ids,
            kind=kind,
            newest_first=newest_first,
            limit=limit,
            emails=emails,
        )
    )

    op_stack = ("users",)
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, monday_credentials)
    return result["users"]

query_users_account(monday_credentials, ids=None, kind=None, newest_first=None, limit=None, emails=None, return_fields=None) async

The user's account.

Parameters:

Name Type Description Default
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
ids Iterable[int]

A list of users unique identifiers.

None
kind UserKind

The kind to search users by (all / non_guests / guests / non_pending).

None
newest_first bool

Get the recently created users at the top of the list.

None
limit int

Number of users to get.

None
emails Iterable[str]

A list of users emails.

None
return_fields Iterable[str]

Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/users.py
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
@task
async def query_users_account(
    monday_credentials: MondayCredentials,
    ids: Iterable[int] = None,
    kind: graphql_schema.UserKind = None,
    newest_first: bool = None,
    limit: int = None,
    emails: Iterable[str] = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    The user's account.

    Args:
        monday_credentials: Credentials to use for authentication with Monday.
        ids: A list of users unique identifiers.
        kind: The kind to search users by (all / non_guests / guests /
            non_pending).
        newest_first: Get the recently created users at the top of the
            list.
        limit: Number of users to get.
        emails: A list of users emails.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.users(
        **strip_kwargs(
            ids=ids,
            kind=kind,
            newest_first=newest_first,
            limit=limit,
            emails=emails,
        )
    ).account(**strip_kwargs())

    op_stack = (
        "users",
        "account",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, monday_credentials)
    return result["users"]["account"]

query_users_teams(monday_credentials, ids=None, kind=None, newest_first=None, limit=None, emails=None, teams_ids=None, return_fields=None) async

The teams the user is a member in.

Parameters:

Name Type Description Default
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

required
ids Iterable[int]

A list of users unique identifiers.

None
kind UserKind

The kind to search users by (all / non_guests / guests / non_pending).

None
newest_first bool

Get the recently created users at the top of the list.

None
limit int

Number of users to get.

None
emails Iterable[str]

A list of users emails.

None
teams_ids Iterable[int]

A list of teams unique identifiers.

None
return_fields Iterable[str]

Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_monday/users.py
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
@task
async def query_users_teams(
    monday_credentials: MondayCredentials,
    ids: Iterable[int] = None,
    kind: graphql_schema.UserKind = None,
    newest_first: bool = None,
    limit: int = None,
    emails: Iterable[str] = None,
    teams_ids: Iterable[int] = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    The teams the user is a member in.

    Args:
        monday_credentials: Credentials to use for authentication with Monday.
        ids: A list of users unique identifiers.
        kind: The kind to search users by (all / non_guests / guests /
            non_pending).
        newest_first: Get the recently created users at the top of the
            list.
        limit: Number of users to get.
        emails: A list of users emails.
        teams_ids: A list of teams unique identifiers.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.users(
        **strip_kwargs(
            ids=ids,
            kind=kind,
            newest_first=newest_first,
            limit=limit,
            emails=emails,
        )
    ).teams(
        **strip_kwargs(
            ids=teams_ids,
        )
    )

    op_stack = (
        "users",
        "teams",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, monday_credentials)
    return result["users"]["teams"]