getLabel( )


Retrieves a label by the specified label key.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Bookings Services and Settings
Manage Contact Labels
Manage Events
Manage Portfolio
Access Verticals by Automations
Manage Members and Contacts - all permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
function getLabel(key: string, options: GetLabelOptions): Promise<ContactLabel>;
Method Parameters
keystringRequired

Label key.

key is generated when the label is created. It can't be modified, even if displayName is updated.


optionsGetLabelOptions

Language options.

Returns
Return Type:Promise<ContactLabel>
JavaScript
import { labels } from "@wix/crm"; async function getLabel(key, options) { const response = await labels.getLabel(key, options); }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?