UserMappingsResponse
Response schema for multiple user mappings
data object[]required
A list of user mappings
external_user objectrequired
This is an object representing a user synced from a connected external account (e.g., a Zoom user).
The email address of the user at the provider.
The first name of the user at the provider.
Unique identifier for the object.
Possible values: Value must match regular expression ^exusr_\w{12}$
The last name of the user at the provider.
String representing the object's type.
Possible values: [external_user]
The status of the user at the provider. 'active' means the user is active, 'inactive' means the user is deactivated or suspended, 'pending' means the user has not yet activated their account. Additional values may be added over time.
Possible values: [active, inactive, pending]
String representing the object's type.
Possible values: [user_mapping]
provider objectrequired
A provider represents a staff member who can provide services to clients.
Time at which the object was created.
The provider's display name.
The provider's email address.
The provider's first name.
Unique identifier for the object.
Possible values: Value must match regular expression ^prov_\w{12}$
The provider's last name.
metadata object
Set of key-value pairs attached to this provider. Maximum size is 16 KB.
Set of key-value pairs attached to this provider. Maximum size is 16 KB.
String representing the object's type.
Possible values: [provider]
The provider's preferred IANA time zone, used as the default when authoring schedules.
Time at which the object was last updated.
How the mapping was established. 'auto' means it was matched automatically by email, 'manual' means it was set explicitly. Additional values may be added over time.
Possible values: [auto, manual]
meta objectrequired
Metadata for paginated responses
Current page number
Number of records per page
Total number of records
Total number of pages
{
"data": [
{
"external_user": {
"email": "dr.smith@example.com",
"first_name": "Jane",
"id": "exusr_d025a96ac0c6",
"last_name": "Smith",
"object": "external_user",
"status": "active"
},
"object": "user_mapping",
"provider": {
"created_at": "2017-09-12T12:34:55Z",
"display_name": "John Smith",
"email": "john@example.com",
"first_name": "John",
"id": "prov_d025a96ac0c6",
"last_name": "Smith",
"metadata": {
"external_id": "123"
},
"object": "provider",
"time_zone": "America/New_York",
"updated_at": "2017-09-13T10:11:12Z"
},
"source": "manual"
}
],
"meta": {
"current_page": 1,
"page_size": 10,
"total_count": 50,
"total_pages": 5
}
}