getLabel( )
Developer Preview
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Retrieves a label by the specified label key.
The getLabel() function returns a Promise that resolves when the specified label is retrieved.
Admin Method
This function requires elevated permissions and runs only on the backend and on dashboard pages.
Permission Scopes
For app development, you must have one of the following permission scopes:Manage Bookings Services and Settings
Manage Contact Labels
Manage Members and Contacts - all permissions
Learn more about permission scopes.
Method Declaration
Copy
Method Parameters
keystringRequired
Label key.
key is generated when the label is created. It cannot be modified, even if displayName is updated.
optionsGetLabelOptions
Language options.
Returns
Return Type:Promise<ContactLabel>
Was this helpful?
Yes
No