Persons

TagmeClientAdvanced.get_person(person_id: str | None = None, organization_id: str | None = None, email: str | None = None, with_organizations: bool | None = None, ) → Person

Get person by id or email.

Parameters

* person_id – person id. Cannot be passed together with email. Defaults to None.

* organization_id – optional organization identifier. Defaults to None.

* email – person email. Cannot be passed together with person_id. Defaults to None.

* with_organizations – include info about organizations. Defaults to None.

Returns

information about user.

TagmeClientAdvanced.get_persons(page: int | None = None, size: int | None = None, query: str | None = None, emails: List[str] | None = None, with_organizations: bool | None = None, organization_id: str | None = None, person_ids: List[str] | None = None, only_active: bool | None = None, ) → List[Person]

Get users list.

Parameters

* page – page number for pagination. Defaults to None.

* size – page size for pagination. Defaults to None.

* query – search query. Defaults to None.

* emails – list of emails to search. Defaults to None.

* with_organizations – include info about organizations. Defaults to None.

* organization_id – optional organization identifier. Defaults to None.

* person_ids – list of person ids to search. Defaults to None.

* only_active – whether to include only active users. Defaults to None.

Returns

list of users.

TagmeClientAdvanced.get_self_person(with_organizations: bool = False, ) → Person

Get information about your user.

Parameters with_organizations – include available organizations. Defaults to False.

Returns

your user information.