> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # GetStaffMember # Package: staffMembers # Namespace: StaffMembersService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/bookings/staff-members/staff-members/get-staff-member.md ## Permission Scopes: Wix Multilingual - Nile Wrapper Domain Events Read: SCOPE.MULTILINGUAL.NILE_WRAPPER_DOMAIN_EVENTS_READ ## Introduction Retrieves a staff member. --- ## REST API ### Schema ``` Method: getStaffMember Description: Retrieves a staff member. URL: https://www.wixapis.com/bookings/v1/staff-members/{staffMemberId} Method: GET # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: staffMemberId Method parameters: query param name: fields | type: array | description: Conditional fields to return. - enum: - RESOURCE_DETAILS: Includes `resource` in the response. - ASSOCIATED_IDENTITY_STATUS: Includes `associatedIdentityStatus` in the response. param name: staffMemberId | type: none | required: true Return type: GetStaffMemberResponse - name: staffMember | type: StaffMember | description: Retrieved staff member. - name: id | type: string | description: Staff member GUID. - name: name | type: string | description: Staff member name. - name: email | type: string | description: Staff member's email address. This field is populated based on the `publiclyAccessible` setting in the [Staff Member Settings API](https://dev.wix.com/docs/api-reference/business-solutions/bookings/staff-members/staff-member-settings/introduction.md). When the setting is disabled, this field is empty if the calling [identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities.md) doesn't have sufficient permissions. Identities with appropriate permissions can access this field regardless of the setting. - name: phone | type: string | description: Staff member's phone number. This field is populated based on the `publiclyAccessible` setting in the [Staff Member Settings API](https://dev.wix.com/docs/api-reference/business-solutions/bookings/staff-members/staff-member-settings/introduction.md). When the setting is disabled, this field is empty if the calling [identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities.md) doesn't have sufficient permissions. Identities with appropriate permissions can access this field regardless of the setting. - name: description | type: string | description: Description for the staff member. For example, `Experienced nail technician specialized in gel and acrylic nails`. - name: mainMedia | type: MediaItem | description: Staff media. - ONE-OF: - name: image | type: Image | description: Staff member's main image. - name: id | type: string | description: WixMedia image GUID. To manage media assets, use the [Media Manager API](https://dev.wix.com/docs/rest/assets/media/media-manager/introduction.md) - name: url | type: string | description: Image URL. - name: height | type: integer | description: Original image height. - name: width | type: integer | description: Original image width. - name: altText | type: string | description: Image alt text. - name: filename | type: string | description: Image filename. - name: resourceId | type: string | description: Staff member's [resource GUID](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resources-v2/introduction.md), identical to `resource.id`. - name: resource | type: Resource | description: Details about the [resource object](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resources-v2/resource-object.md) associated with the staff member. Available only if you specify `RESOURCE_DETAILS` in the `fields` array. - name: id | type: string | description: GUID of the [resource](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction.md) associated with the staff member. - name: workingHoursSchedules | type: array | description: Working hour [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction.md) of the staff member. By default, identical the opening hours of the business's [default location](https://dev.wix.com/docs/rest/business-management/locations/introduction.md). If the staff has custom working hours, identical to `eventsSchedule`. - name: id | type: string | description: GUID of the working hour [schedule](https://dev.wix.com/docs/api-reference/business-management/calendar/schedules-v3/introduction.md) associated with the staff member. Currently, each staff member can't have more than a single working hour schedule. Learn more about [how Wix Bookings uses the Calendar APIs](https://dev.wix.com/docs/api-reference/business-management/calendar/wix-bookings-integration.md). - name: shared | type: boolean | description: Whether the working hour schedule is shared with the business. If this field isn't available, the schedule isn't shared but specific for the staff member. - name: eventsSchedule | type: EventSchedule | description: Event [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction.md) of the staff member. - name: id | type: string | description: GUID of the event [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction.md) associated with the staff member. Learn more about _how Wix Bookings uses the Calendar APIs_ [Wix Bookings](https://dev.wix.com/docs/rest/business-management/calendar/wix-bookings-integration.md). - name: usesDefaultWorkingHours | type: boolean | description: Whether the staff member works according to business's [default location](https://dev.wix.com/docs/rest/business-management/locations/introduction.md) opening hours. `false`: The staff has custom working hours. Default: `true` - name: revision | type: string | description: Revision number, which increments by 1 each time the resource is updated. - name: associatedWixIdentity | type: AssociatedWixIdentity | description: Identity of the Wix user associated with the staff member. Learn more about [identities](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities.md). - name: identificationData | type: IdentificationData | description: Information about the identity connected to the staff member. Available only if the staff member is connected to a Wix user. Learn more about [identities](https://dev.wix.com/docs/rest/articles/getting-started/about-identities.md). - ONE-OF: - name: anonymousVisitorId | type: string | description: GUID of a site visitor that has not logged in to the site. - name: memberId | type: string | description: GUID of a site visitor that has logged in to the site. - name: wixUserId | type: string | description: GUID of a Wix user (site owner, contributor, etc.). - name: appId | type: string | description: GUID of an app. - name: contactId | type: string | description: GUID of of a contact in the site's [CRM by Ascend](https://www.wix.com/ascend/crm) system. Retrievable via the [Contacts API](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/introduction.md) - name: connection | type: Connection | description: Connection status. Available only if you specify `ASSOCIATED_IDENTITY_STATUS` in the `fields` array. - name: status | type: ConnectionStatus | description: Connection status of the Wix user and the staff member. - enum: - UNKNOWN: There is no information about the connection status. - CONNECTED: The Wix user is connected to the staff member. - PENDING: The Wix user must accept the invitation to join **.wix.com.** or the site. - EXPIRED: The invitation to join **.wix.com.** or the site has expired. - DISCONNECTED: The Wix user was disconnected from the staff member. - name: revision | type: string | description: Revision number, which increments by 1 each time the staff member is updated. To prevent conflicting changes, the current revision must be passed when updating the staff member. - name: createdDate | type: string | description: Time the staff member was created in `YYYY-MM-DDThh:mm:ss.sssZ` format. - name: updatedDate | type: string | description: Time the staff member was last updated in `YYYY-MM-DDThh:mm:ss.sssZ` format. - name: extendedFields | type: ExtendedFields | description: Extensions enabling users to save custom data related to the staff member. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: tags | type: Tags | description: Tags allowing you to classify staff members. Learn more about [tags](https://dev.wix.com/docs/api-reference/business-management/tags/introduction.md). - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors. - name: tagIds | type: array | description: List of tag GUIDs - name: tags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. ``` ### Examples ### Retrieve a staff member ```curl curl -X GET \ 'https://www.wixapis.com/bookings/v1/staff-members/0954bbb2-88cd-445c-9827-44253eb8b039' \ -H 'Authorization: ' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.staffMembers.StaffMembersService.getStaffMember(staffMemberId, options) Description: Retrieves a staff member. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: staffMemberId Method parameters: param name: options | type: GetStaffMemberOptions none - name: fields | type: array | description: Conditional fields to return. - enum: - RESOURCE_DETAILS: Includes `resource` in the response. - ASSOCIATED_IDENTITY_STATUS: Includes `associatedIdentityStatus` in the response. param name: staffMemberId | type: string | description: GUID of the staff member to retrieve. | required: true Return type: PROMISE - name: _id | type: string | description: Staff member GUID. - name: name | type: string | description: Staff member name. - name: email | type: string | description: Staff member's email address. This field is populated based on the `publiclyAccessible` setting in the [Staff Member Settings API](https://dev.wix.com/docs/api-reference/business-solutions/bookings/staff-members/staff-member-settings/introduction.md). When the setting is disabled, this field is empty if the calling [identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities.md) doesn't have sufficient permissions. Identities with appropriate permissions can access this field regardless of the setting. - name: phone | type: string | description: Staff member's phone number. This field is populated based on the `publiclyAccessible` setting in the [Staff Member Settings API](https://dev.wix.com/docs/api-reference/business-solutions/bookings/staff-members/staff-member-settings/introduction.md). When the setting is disabled, this field is empty if the calling [identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities.md) doesn't have sufficient permissions. Identities with appropriate permissions can access this field regardless of the setting. - name: description | type: string | description: Description for the staff member. For example, `Experienced nail technician specialized in gel and acrylic nails`. - name: mainMedia | type: MediaItem | description: Staff media. - ONE-OF: - name: image | type: string | description: Staff member's main image. - name: resourceId | type: string | description: Staff member's [resource GUID](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resources-v2/introduction.md), identical to `resource.id`. - name: resource | type: Resource | description: Details about the [resource object](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resources-v2/resource-object.md) associated with the staff member. Available only if you specify `RESOURCE_DETAILS` in the `fields` array. - name: _id | type: string | description: GUID of the [resource](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction.md) associated with the staff member. - name: workingHoursSchedules | type: array | description: Working hour [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction.md) of the staff member. By default, identical the opening hours of the business's [default location](https://dev.wix.com/docs/rest/business-management/locations/introduction.md). If the staff has custom working hours, identical to `eventsSchedule`. - name: _id | type: string | description: GUID of the working hour [schedule](https://dev.wix.com/docs/api-reference/business-management/calendar/schedules-v3/introduction.md) associated with the staff member. Currently, each staff member can't have more than a single working hour schedule. Learn more about [how Wix Bookings uses the Calendar APIs](https://dev.wix.com/docs/api-reference/business-management/calendar/wix-bookings-integration.md). - name: shared | type: boolean | description: Whether the working hour schedule is shared with the business. If this field isn't available, the schedule isn't shared but specific for the staff member. - name: eventsSchedule | type: EventSchedule | description: Event [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction.md) of the staff member. - name: _id | type: string | description: GUID of the event [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction.md) associated with the staff member. Learn more about _how Wix Bookings uses the Calendar APIs_ [Wix Bookings](https://dev.wix.com/docs/rest/business-management/calendar/wix-bookings-integration.md). - name: usesDefaultWorkingHours | type: boolean | description: Whether the staff member works according to business's [default location](https://dev.wix.com/docs/rest/business-management/locations/introduction.md) opening hours. `false`: The staff has custom working hours. Default: `true` - name: revision | type: string | description: Revision number, which increments by 1 each time the resource is updated. - name: associatedWixIdentity | type: AssociatedWixIdentity | description: Identity of the Wix user associated with the staff member. Learn more about [identities](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities.md). - name: identificationData | type: IdentificationData | description: Information about the identity connected to the staff member. Available only if the staff member is connected to a Wix user. Learn more about [identities](https://dev.wix.com/docs/rest/articles/getting-started/about-identities.md). - ONE-OF: - name: anonymousVisitorId | type: string | description: GUID of a site visitor that has not logged in to the site. - name: memberId | type: string | description: GUID of a site visitor that has logged in to the site. - name: wixUserId | type: string | description: GUID of a Wix user (site owner, contributor, etc.). - name: appId | type: string | description: GUID of an app. - name: contactId | type: string | description: GUID of of a contact in the site's [CRM by Ascend](https://www.wix.com/ascend/crm) system. Retrievable via the [Contacts API](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/introduction.md) - name: connection | type: Connection | description: Connection status. Available only if you specify `ASSOCIATED_IDENTITY_STATUS` in the `fields` array. - name: status | type: ConnectionStatus | description: Connection status of the Wix user and the staff member. - enum: - UNKNOWN: There is no information about the connection status. - CONNECTED: The Wix user is connected to the staff member. - PENDING: The Wix user must accept the invitation to join **.wix.com.** or the site. - EXPIRED: The invitation to join **.wix.com.** or the site has expired. - DISCONNECTED: The Wix user was disconnected from the staff member. - name: revision | type: string | description: Revision number, which increments by 1 each time the staff member is updated. To prevent conflicting changes, the current revision must be passed when updating the staff member. - name: _createdDate | type: Date | description: Time the staff member was created in `YYYY-MM-DDThh:mm:ss.sssZ` format. - name: _updatedDate | type: Date | description: Time the staff member was last updated in `YYYY-MM-DDThh:mm:ss.sssZ` format. - name: extendedFields | type: ExtendedFields | description: Extensions enabling users to save custom data related to the staff member. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: tags | type: Tags | description: Tags allowing you to classify staff members. Learn more about [tags](https://dev.wix.com/docs/api-reference/business-management/tags/introduction.md). - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors. - name: tagIds | type: array | description: List of tag GUIDs - name: tags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. ``` ### Examples ### getStaffMember ```javascript import { staffMembers } from '@wix/bookings'; async function getStaffMember(staffMemberId,options) { const response = await staffMembers.getStaffMember(staffMemberId,options); }; ``` ### getStaffMember (with elevated permissions) ```javascript import { staffMembers } from '@wix/bookings'; import { auth } from '@wix/essentials'; async function myGetStaffMemberMethod(staffMemberId,options) { const elevatedGetStaffMember = auth.elevate(staffMembers.getStaffMember); const response = await elevatedGetStaffMember(staffMemberId,options); } ``` ### getStaffMember (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { staffMembers } from '@wix/bookings'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { staffMembers }, // Include the auth strategy and host as relevant }); async function getStaffMember(staffMemberId,options) { const response = await myWixClient.staffMembers.getStaffMember(staffMemberId,options); }; ``` ---