Skip to main content

ServiceProviderConferencingResponse

Response schema for a single service provider conferencing configuration

data objectrequired

This is an object representing the conferencing configuration for a service provider (e.g., the Zoom user whose account hosts meetings for this provider on this service).

conferencing_providerstringrequired

The conferencing provider used to host meetings.

Possible values: [zoom_admin]

connected_account objectrequired

This is an object representing a connected external account (e.g., a Google Calendar or Microsoft 365 integration).

connection_scopestringrequired

The scope of this connection. 'user' means owned by a specific user, 'account' means shared across the account.

Possible values: [user, account]

created_atdate-timerequired

Time at which the object was created.

display_namestringnullablerequired

The display name from the provider.

emailstringrequired

The email address associated with this connected account.

external_account_idstringnullablerequired

The unique identifier for the organization at the provider (e.g., Zoom account number).

external_subjectstringrequired

The unique identifier for this account at the provider.

idstringrequired

Unique identifier for the object.

Possible values: Value must match regular expression ^cact_\w{12}$

objectstringrequired

String representing the object's type.

Possible values: [connected_account]

providerstringrequired

The provider for this connected account.

Possible values: [google, microsoft, zoom_admin]

statusstringrequired

The current status of the connection. 'active' means the connection is working, 'reconnect_required' means the OAuth token has failed and needs reauthorization, 'insufficient_permissions' means the user did not grant all required OAuth scopes.

Possible values: [active, reconnect_required, insufficient_permissions]

updated_atdate-timerequired

Time at which the object was last updated.

user_idstringnullablerequired

The ID of the user who owns this connected account.

external_user objectrequired

This is an object representing a user synced from a connected external account (e.g., a Zoom user).

emailstringnullablerequired

The email address of the user at the provider.

first_namestringnullablerequired

The first name of the user at the provider.

idstringrequired

Unique identifier for the object.

Possible values: Value must match regular expression ^exusr_\w{12}$

last_namestringnullablerequired

The last name of the user at the provider.

objectstringrequired

String representing the object's type.

Possible values: [external_user]

statusstringnullablerequired

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]

objectstringrequired

String representing the object's type.

Possible values: [service_provider_conferencing]

provider_idstringrequired

The ID of the provider.

Possible values: Value must match regular expression ^prov_\w{12}$

service_idstringrequired

The ID of the service.

Possible values: Value must match regular expression ^srv_\w{12}$

ServiceProviderConferencingResponse
{
"data": {
"conferencing_provider": "zoom_admin",
"connected_account": {
"connection_scope": "user",
"created_at": "2025-03-12T12:34:55Z",
"display_name": "John Doe",
"email": "user@example.com",
"external_account_id": null,
"external_subject": "123456789",
"id": "cact_d025a96ac0c6",
"object": "connected_account",
"provider": "google",
"status": "active",
"updated_at": "2025-03-13T10:11:12Z",
"user_id": "user_d025a96ac0c6"
},
"external_user": {
"email": "dr.smith@example.com",
"first_name": "Jane",
"id": "exusr_d025a96ac0c6",
"last_name": "Smith",
"object": "external_user",
"status": "active"
},
"object": "service_provider_conferencing",
"provider_id": "prov_d025a96ac0c6",
"service_id": "srv_d025a96ac0c6"
}
}