Get Manager's Profile
GET
v1/managers/account/profileRetrieves the profile data of the authenticated Manager. This includes detailed information about the Manager, their role, associated store, and the set of permissions they hold.
This operation is exclusively for users with the Manager role (Store Owner, Store Moderator). Customer roles are not allowed to access this endpoint.
The system identifies the Manager and the related store via the X-Manager-Token
. The Authorization
token validates the user's access to the API.
For a detailed explanation of user roles and permissions, refer to our User Roles and Permissions guide.
Request
Preferred language for the response. Defaults to en
if not specified.
The Authorization token is a unique key given to the third-party application (Partner) by Zid. It is used to authenticate the API requests made by the Partner application. The token verifies the partner's identity and ensures they have permission to access Zid's API but does not provide any specific user or store information. It should be included in the header of API requests when the partner application needs to access Zid's API.
This token is used to authenticate and access information related to the store. It is obtained through an OAuth mechanism and is required to perform operations on the store's data. The X-Manager-Token
should be included in the header of API requests that require store-related information.
The User-Agent header contains information about the user agent (browser or app) making the request. It allows the server to provide a tailored response depending on the user agent's capabilities and preferences.
Request samples
Responses
The unique identifier of the manager.
The previous unique identifier of the manager, if any.
The unique universally unique identifier (UUID) of the manager.
The full name of the manager.
The manager's username, usually an email address.
The manager's email address.
Indicates if the manager's email is verified. True if it is, otherwise false.
The manager's mobile number, including the country code.
The mobile number information of the store.
The country calling code.
The local mobile number without the initial '0', as commonly used in some countries.
The gender of the manager. 'm' for male, 'f' for female.
The unique hash of the user in Intercom for customer communication and support.
The reference code of the manager in VLoops, if applicable.
Contains additional data related to the user's personal and professional details.
The birth date of the user.
The ID of the country where the user resides.
The ID of the city where the user resides.
Indicates if the user is an employee of the organization. True if yes, otherwise false.
The name of the organization where the user works. If the user isn't an employee of an organization, this is null.
The job title of the user within the organization. If the user isn't an employee of an organization, this is null.
Contains the business location details of the user.
The country where the business is located.
The city where the business is located.
The district where the business is located.
The street where the business is located.
The building number where the business is located.
The postal code of the business location.
Any additional postal code related to the business location.
The latitude of the business location.
The longitude of the business location.
Indicates if the business location should be displayed. True if it should be displayed, otherwise false.
An array of the roles assigned to the manager. Each item in the array is an object that includes the unique ID, slug, and name of the role.
An array of permissions assigned to the manager. Each permission is an object and includes the details of a specific permission.
A unique identifier associated with each permission, typically in the form of a UUID.
A URL-friendly identifier that signifies the action or access level of the permission. Slugs are typically lowercase with words separated by periods (.) and provide a human-readable way to describe the permission in system logic.
A user-friendly name for the permission. This is often displayed in user interfaces to help users understand the purpose of the permission.
A brief explanation of what actions or access this permission grants to the manager. This helps in understanding the context of use for this permission.
The precedence value for the permission. Higher values indicate a higher level of priority. Multiple permissions can have the same order value, reflecting equal precedence.
Unique identifier of the store.
Universally unique identifier of the store.
The username associated with the store, typically the manager's name followed by "store".
The official name of the store.
The contact phone number of the store.
The mobile number information of the store.
Detailed business-related data associated with the store.
The commercial registration number of the store.
Whether the commercial registration number is activated.
The email address associated with the store.
The URL of the store's website.
The SSL-enabled URL of the store's website.
The URL of the store's sitemap.
The currency information associated with the store.
List of currencies supported by the store. This includes all currencies that the store can do transactions in.
Information about the language used in the store.
List of languages supported by the store. This includes all languages that the store's website can be displayed in.
Information about the store's theme.
The URL of the store's logo.
An array of URLs of different versions of the store's logo. Empty array if the store doesn't have a logo.
The URL of the store's cover image.
The URL of the store's icon.
Indicates if the store is in maintenance mode. True if in maintenance mode, otherwise false.
Indicates if the store has a new products service. True if it does, otherwise false.
The URL of the store's Facebook page.
The URL of the store's Twitter profile.
The URL of the store's Instagram profile.
The username of the store's Snapchat account.
The username of the store's TikTok account.
The Authentication Number of the Business Platform as provided by the Saudi Business Center (المركز السعودي للأعمال) which is the new governmental platform for verifying online stores, replacing the previously used Maroof service. For more details, visit Saudi Business Center FAQs.
In the Merchant Dashboard, this value can be found at Settings > Store Information in the text field labeled "Business Center" or "منصة الأعمال".
The URL of the store's Maroof page.
Note: The maroof
field deprecated since
Maroof has been replaced by the
Saudi Business Center.
The URL of the store's official website. Null
if the store doesn't have an official website apart from the Zid store.
Array of OneSignal keys used for push notifications.
The current balance of SMS campaigns.
The sender name information for SMS campaigns.
Information about the store's customer acquisition program.
The discount code provided to new users upon registration.
Information about the industry that the store belongs to.
Additional category information, if the store doesn't fit neatly into one category.
If set to true, a notification will be shown when the store category is selected.
An array of malls where the store's products are available.
Indicates if customers are required to provide their email during checkout.
Indicates if customers can log in using their email. True if enabled, otherwise false.
Indicates if Google Maps and SPL are enabled in the address input.
Indicates if Google Maps is enabled in the address input.
Indicates if providing an address via Google Maps is mandatory.
Indicates if SPL is enabled in the address input.
Indicates if restocking of cancelled orders is enabled.
Indicates if a label for low stock is enabled.
Indicates if product reviews are enabled.
Defines the quantity limit that triggers the low stock label.
Indicates if a different consignee (receiver) is allowed for the orders.
The meta description for the store's website for SEO.
The meta title for the store's website for SEO.
The privacy policy details of the store.
The terms and conditions of the store.
Complaints and suggestions contact details or methods.
The licensing details for the store.
The refund and exchange policy details of the store.
Indicates if Value Added Tax (VAT) is required in the store's subscription.
The subscription details of the store.
Information about the store's availability or operating status.
The timestamp when the store was created.
Indicates if the mobile number associated with the store is verified.
Indicates if the readiness checks for the store are completed.
The token for accessing the store's analytics dashboard.
The theme of the storefront for the store.
Indicates if ZidPay, a payment solution, is activated for the store.
Indicates if ZidShip, a shipping solution, is activated for the store.
Indicates if Apple Pay is enabled for all browsers in the store.
Indicates if the option for customers to buy as a guest is enabled in the store.
A list of system tags associated with the store.
Indicates if the store has a new shipping module.
Indicates if the store supports the Multi-Inventory feature.
Indicates if the store has a point of sale (POS) system.
Indicates if the store has a business-to-business (B2B) subscription.
Indicates whether the store exclusively uses and supports the latest theme format, restricting the use of older theme versions. This field is deprecated since the use of old themes has been discontinued, and existing old themes have been migrated to the new theme format.
The timestamp when the manager's profile was created, in YYYY-MM-DD HH:MM:SS format.
The manager's public key in TAP Payments for secure payment processing.