This HTTP POST request is used to obtain an access token by providing the user's credentials and grant type.
\nUse Basic Authorization type. The basic token is a Base64 encoded string generated by combining the Client ID and Client Secret. You can retrieve the basic token by Base64 encoding the following string:{{client_id}}:{{client_secret}}
grant_type (text) - The type of grant being requested.
username (text) - Base64 encoding of the user's organizationURL and username.
password (text) - The password of the user.
username encoding pre-scriptconst username = pm.environment.get(\"username\");\nconst organizationUrl = pm.environment.get(\"organization_url\");\nconst concatenatedUsername = organizationUrl + \":\" + username;\nconst encodedUsername = Buffer.from(concatenatedUsername).toString('base64');\npm.environment.set(\"encoded_username\", encodedUsername);\n\nUpon successful execution, the response will include the following fields:
\naccess_token - The access token for authentication.
token_type - The type of token.
expires_at - The expiration time of the token.
refresh_token - The refresh token for obtaining a new access token.
scope - The scope of the access token.
identity - An object containing user identity information.
{\n \"access_token\": \"\",\n \"token_type\": \"\",\n \"expires_at\": \"\",\n \"refresh_token\": \"\",\n \"scope\": [\"\"],\n \"identity\": {\n \"__typename\": \"\",\n \"id\": \"\",\n \"username\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"role\": \"\",\n \"status\": \"\",\n \"workStatus\": \"\",\n \"eulaStatus\": true\n }\n}\n\nThis folder contains endpoints for authorization and authentication. These endpoints are used to authenticate users and generate access tokens for accessing protected resources.
\nBelow are the list of base URLs to use to access the authorization server. Use the appropriate URL for the region you are authenticating with.
\nCA: https://auth.prod.ca.hypercare.com
\nUS: https://auth.prod.us.hypercare.com
\nEU: https://auth.prod.eu.hypercare.com
\n","_postman_id":"4c5dc1a7-880b-4ee3-baa5-2a2fa11edc3c"},{"name":"Public (Unauthenticated)","item":[{"name":"Get public user basic info","id":"5e6a328a-4509-47a2-b1e9-cb99f5e77289","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"graphql","graphql":{"query":"query GetPublicUser($email: String!, $organizationUrl: String!) {\n user(email: $email, organizationUrl: $organizationUrl) {\n ... on Error {\n __typename\n message\n }\n ... on PublicUser {\n firstName\n lastName\n role\n accountStatus\n isDomainEmail\n loginMethods\n isAdmin\n \n ssoProfiles {\n organization {\n name\n imageURL\n }\n auth0Id\n ssoId\n ssoVendor\n domain\n }\n }\n }\n}\n","variables":"{\n \"email\": \"{{email}}\",\n \"organizationUrl\": \"{{organizationURL}}\"\n}"}},"url":"{{api_base_url}}/v2/graphql/public","description":"This GraphQL query retrieves user information based on the provided email and organization URL. It checks the user's membership status within the organization and returns the appropriate user details or error messages.
\nemail (String): The email address of the user.
\norganizationUrl (String): The URL of the organization.
\nPublicUser: Contains the user details if the user is found and active.
OrganizationNotFound: Returned if the organization URL does not match any existing organization.
UserNotFound: Returned if no user is found for the given email address within the organization.
MemberBlocked: Returned if the user's address is blacklisted for the organization.
OrganizationNotFound: Returned if the organization URL does not match any existing organization.
UserNotFound: Returned if no user is found for the given email address within the organization.
MemberBlocked: Returned if the user's address is blacklisted for the organization.
This GraphQL query creates a new user account within an organization. It validates the user details, verifies the address challenge, and ensures that the user meets the necessary requirements before creating the account.
\nThe challengeId is a unique identifier used to verify the address associated with the user account. It ensures that the address provided by the user is valid and can be used for account creation.
\norganizationUrl (String): The URL of the organization.
\nuserDetails (Object): An object containing the user's details:
\nfirstName (String): The first name of the user.
\nlastName (String): The last name of the user.
\nrole (String): The role / job title of the user.
\npassword (String): The password for the user account.
\nchallengeId (String): The ID of the address verification challenge.
\ninviteCode (String, optional): The invite code for the organization. If a user is not signing up with an email domain that is associated with out organization, an invite code is needed in order to join.
\nAn object representing the result of the account creation process. If the account creation is successful, it returns the user details. If there is an error, it returns an error type and message.
\nInvalidDetailsError: Returned if the user details do not meet the required validation criteria.
InvalidChallengeError: Returned if the address verification challenge is invalid or cannot be verified.
OrganizationNotFoundError: Returned if the organization URL does not match any existing organization.
MemberBlockedError: Returned if the address is blacklisted for the organization.
AccessForbiddenError: Returned if there is an error finalizing the user creation process.
This GraphQL query activates an user account by claiming an inactive account associated with a given address. It verifies the address challenge, checks for an inactive member, and updates the user details to activate the account.
\nThe challengeId is a unique identifier used to verify the address associated with the user account. It ensures that the address provided by the user is valid and can be used for account activation.
organizationUrl (String): The URL of the organization.
userDetails (Object): An object containing the user's details:
\nfirstName (String): The first name of the user.
lastName (String): The last name of the user.
role (String): The role of the user.
password (String, optional): The password for the user account.
\nchallengeId (String): The ID of the address verification challenge.
An object representing the result of the account activation process. If the account activation is successful, it returns the user details. If there is an error, it returns an error type and message.
\nOrganizationNotFound: Returned if the organization URL does not match any existing organization.
ShellAccountNotFound: Returned if no inactive member with the given address is found or if the member is not a shell account.
PasswordRequirementsNotMet: Returned if the organization requires a password and it is not provided.
ErrorType: Returned for any other errors that occur during the account activation process.
This GraphQL query retrieves an array of organizations by fuzzy matching against its display name and returns the organization details or an error message if the organization is not found. Only public organizations will be returned. Organizations are private by default. Please contact our Customer Success team if you wish to enable public search for your organization.
\nname (String): The name of the organization to search for.An object representing the organization details or an error message. The possible return types are:
\nOrganization: Contains the organization details if the organization is found.
OrganizationNotFound: Returned if no organization with the given name is found.
OrganizationNotFound: Returned if no organization with the given name is found.This GraphQL query retrieves organization details based on the provided domain. It searches for the organization associated with the given domain and returns the organization details or an error message if the organization is not found.
\ndomain (String): The domain of the organization to search for.An object representing the organization details or an error message. The possible return types are:
\nOrganization: Contains the organization details if the organization is found.
OrganizationNotFound: Returned if no organization with the given domain is found.
OrganizationNotFound: Returned if no organization with the given domain is found.This GraphQL query retrieves organization details based on the provided URL. It searches for the organization associated with the given URL and returns the organization details or an error message if the organization is not found.
\nurl (String): The URL of the organization to search for.An object representing the organization details or an error message. The possible return types are:
\nOrganization: Contains the organization details if the organization is found.
OrganizationNotFound: Returned if no organization with the given domain is found.
OrganizationNotFound: Returned if no organization with the given domain is found.This GraphQL query retrieves organization details by matching its exact display name and returns the organization details or an error message if the organization is not found.
\nname (String): The exact name of the organization to search for.An object representing the organization details or an error message. The possible return types are:
\nOrganization: Contains the organization details if the organization is found.
OrganizationNotFound: Returned if no organization with the given domain is found.
OrganizationNotFound: Returned if no organization with the given domain is found.This GraphQL query retrieves organization details based on the provided invite code. It searches for the organization associated with the given invite code and returns the organization details or an error message if the organization is not found.
\ncode (String): The invite code of the organization to search for.An object representing the organization details or an error message. The possible return types are:
\nOrganization: Contains the organization details if the organization is found.
OrganizationNotFound: Returned if no organization with the given domain is found.
OrganizationNotFound: Returned if no organization with the given domain is found.GraphQL query for admins to fetch a specific invite by its ID.
\norganizationalUnit (Object)
id (String): The ID of the organizational unit in context
type (String): Organization unit type (e.g. \"organization\", \"site\", \"department\")
inviteId (Int): The ID of the invite
OrganizationalUnitNotFoundError: The organization ID provided does not correspond to an existing organization
UserNotAdminForScope: User is not an admin of the organizational unit they are checking against
InviteNotFound: No invite found for the given ID
GraphQL query for admins to retrieve a paginated list of pending invites for an organization. It supports filtering by invite status and search query, and it uses cursor-based pagination.
\norganizationalUnit (Object)
id (String): The ID of the organization for which pending invites are being retrieved
type (String): Organization unit type (e.g. \"organization\", \"site\", \"department\")
filters (Object): An object containing the following optional filters
searchQuery(String, optional): A search query to filter invites by
inviteStatus (Array, optional): An array of invite statuses to filter by. Defaults to [InviteStatus.pendingUserAcceptance, InviteStatus.pendingAdminApproval].
pageInfo(Object): An object containing pagination information:
cursor(String, optional): The cursor for the current page
pageSize (Int, optional): The number of results per page
direction(String, optional): The direction of pagination (e.g., \"forward\" or \"backward\")
OrganizationalUnitNotFoundError: The organization ID provided does not correspond to an existing organization
UserNotAdminForScope: User is not an admin of the organizational unit they are checking against
GraphQL mutation for admins to invite users to an organization. It verifies the user's permissions and then sends invitations to the specified users. If an address being invited was previously blackedlisted, this will first whitelist the address, then re-invite.
\norganizationalUnit (Object)
id (String): The ID of the organizational unit in context
type (String): Organization unit type (e.g. \"organization\", \"site\", \"department\")
accounts (Object):
addresses(Object)
address (String): The email address to which invitation will be sent
type (String): The type of address (e.g. \"email\")
profile(Object, optional): Additional user information that can be added during the inactive/shell account invite/creation process. If no profile information is provided, the invited email will be used as the first name by default
firstName (String)
lastName (String)
role (String)
FullOrganizationMember being the successful resultOrganizationalUnitNotFoundError: The organization ID provided does not correspond to an existing organization
UserNotAdminForScope: User is not an admin of the organizational unit they are checking against
AddressInUse: One or more addresses are linked with an existing user in the organization
EmailAddressMissing: Email is required for invites
GraphQL mutation for admins to approve a pending invite given its ID.
\norganizationalUnit (Object)
id (String): The ID of the organizational unit in context
type (String): Organization unit type (e.g. \"organization\", \"site\", \"department\")
inviteId (Int): The ID of the invite
OrganizationalUnitNotFoundError: The organization ID provided does not correspond to an existing organization
UserNotAdminForScope: User is not an admin of the organizational unit they are checking against
InviteNotFound: No invite found for the given ID
InviteAlreadyAccepted: Invite has already been accepted by the invitee
InviteAlreadyDeclined: Invite has already been declined by the invitee
InviteAlreadyCanceled: Invite has already been canceled by an admin
InviteAlreadyRejected: Invite has already been rejected by an admin
ApprovalNotRequired: This invite does not require admin approval
GraphQL mutation for admins to reject a pending invite given its ID.
\norganizationalUnit (Object)
id (String): The ID of the organizational unit in context
type (String): Organization unit type (e.g. \"organization\", \"site\", \"department\")
inviteId (Int): The ID of the invite
OrganizationalUnitNotFoundError: The organization ID provided does not correspond to an existing organization
UserNotAdminForScope: User is not an admin of the organizational unit they are checking against
InviteNotFound: No invite found for the given ID
InviteAlreadyAccepted: Invite has already been accepted by the invitee
InviteAlreadyDeclined: Invite has already been declined by the invitee
InviteAlreadyCanceled: Invite has already been canceled by an admin
InviteAlreadyRejected: Invite has already been rejected by an admin
ApprovalNotRequired: This invite does not require admin approval
GraphQL mutation for admins to create a new site within an organization. It verifies the user's permissions and then creates the site with the specified details.
\norganizationalUnit (Object)
id(Int): The ID of the organization where the site is being created.
type (String): organization
siteDetails (Object)
name (String): The name of the site
image (String): The image URL of the site. See Upload Files
OrganizationalUnitNotFoundError: The organization ID is invalid
UserNotAdminForScope: The current user does not have permission to create a site within the organization
GraphQL mutation for admins to create a new department within a site. It verifies the user's permissions and then creates the department with the specified details.
\norganizationalUnit (Object)
id(Int): The ID of the site where the department is being created.
type (String): \"site\"
departmentDetails (Object)
name (String): The name of the department
image (String): The image URL of the department. See Upload Files
OrganizationalUnitNotFoundError: The site ID given is invalid
UserNotAdminForScope: The current user does not have permission to create a department within the site
GraphQL query for admins to retrieve the synchronization status of an organizational unit with an external directory such as AzureAD.
\norganizationalUnit(Object)
id(Int): The ID of the organizational unit in context
type (String): Organizational unit type (e.g. organization/site/department)
UserNotAdminForScope: User is not an admin of the organizational unit they are checking against
OrganizationalUnitNotFoundError: The organizational unit being check cannot be found
GraphQL query for admins to retrieve a paginated list of users who's address has been blacklisted for an organization. It supports filtering by search query and uses cursor-based pagination.
\norganizationalUnit (Object)
id (String): The ID of the organizational unit in context
type (String): Organization unit type (e.g. \"organization\", \"site\", \"department\")
filters (Object): An object containing the following optional filters
searchQuery(String, optional): A search query to filter invites bypageInfo(Object): An object containing pagination information:
cursor(String, optional): The cursor for the current page
pageSize (Int, optional): The number of results per page
direction(String, optional): The direction of pagination (e.g., \"forward\" or \"backward\")
OrganizationalUnitNotFoundError: The organization ID provided does not correspond to an existing organization
UserNotAdminForScope: User is not an admin of the organizational unit they are checking against
This section contains functionalities only accessable to users with administrator privileges. The error UserNotAdminForScope will return for all unauthorized access.
GraphQL query for retrieving a paginated list of users for an organization. It supports filtering by member status, multiple organizational scopes, and search string, and it uses cursor-based pagination.
\norganizationalUnit (Object)
id (String): The ID of the organizational unit
type (String): Organization unit type (e.g. \"organization\", \"site\", \"department\")
filters (Object): An object containing the following optional filters
memberStatus([String], optional): The statuses of the users you wish to retreve (e.g. \"active\", \"inactive\", \"blocked\", \"archived\")
organizationaUnits ([String], optional): The scope which the users being retrived are in
searchQuery (String, optional): Search terms
pageInfo(Object): An object containing pagination information:
cursor(String, optional): The cursor for the current page
pageSize (Int, optional): The number of results per page
direction(String, optional): The direction of pagination (e.g., \"next\" or \"previous\")
OrganizationalUnitNotFoundError: The organization ID provided does not correspond to an existing organizationGraphQL query to fetch the profile fields for a user as it's seen on their user profile page.
\norganizationalUnit (Object)
id (String): The ID of the organizational unit in context
type (String): Organization unit type (e.g. \"organization\", \"site\", \"department\")
userId (Int): The ID of the user
OrganizationalUnitNotFoundError: The organization ID provided does not correspond to an existing organization
UserNotAdminForScope: User is not an admin of the organizational unit they are checking against
UserNotFound: No user found for the given ID
GraphQL query for retrieving a paginated list of invites sent by the user. It supports filtering by invite status and search query, and it uses cursor-based pagination.
\nfilters (Object): An object containing the following optional filters
searchQuery(String, optional): A search query to filter invites by
inviteStatus ([String], optional): An array of invite statuses to filter by. Defaults to [\"pending_user_acceptance\", \"pending_admin_approval\"].
pageInfo(Object): An object containing pagination information:
cursor(String, optional): The cursor for the current page
pageSize (Int, optional): The number of results per page
direction(String, optional): The direction of pagination (e.g., \"forward\" or \"backward\")
OrganizationalUnitNotFoundError: The organization ID provided does not correspond to an existing organizationGraphQL mutation for non-admins to invite users to an organization. It verifies the user's permissions and then sends invitations to the specified users. If an address was previously blacklisted for the organization, an error will be thrown
\ninvitees (Object):
addresses(Object)
address (String): The email address to which invitation will be sent
type (String): The type of address (e.g. \"email\")
profile(Object, optional): Additional user information that can be added during the inactive/shell account invite/creation process. If no profile information is provided, the invited email will be used as the first name by default
firstName (String)
lastName (String)
role (String)
OrganizationMember being the successful resultOrganizationalUnitNotFoundError: The organization ID provided does not correspond to an existing organization
AddressInUse: One or more addresses are linked with an existing user in the organization
EmailAddressMissing: Email is required for invites
AccountBlocked: Cannot invite an email that belongs to an blacklisted account
GraphQL query to fetch the admin status of all organizational units I am a part of
\nisAdmin is true for eachGraphQL query for fetching an organizational unit by it's ID.
\norganizationalUnit (Object)
id (String): The ID of the organizational unit in context
type (String): Organization unit type (e.g. \"organization\", \"site\", \"department\")
OrganizationalUnitNotFoundError: The inputted organizational unit ID does not exist@return a list of all your organizations
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_bearer}}"}]},"isInherited":true,"source":{"_postman_id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","name":"Private (Authenticated)","type":"folder"}},"urlObject":{"protocol":"https","path":["v2","graphql","private"],"host":["{{api_hostname}}"],"query":[],"variable":[]}},"response":[{"id":"27e28598-911e-4b48-b460-fee2c0150ac0","name":"Success Sample Response","originalRequest":{"method":"POST","header":[{"key":"hypercare-scope","value":"{{scopetoken}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query GetOrganizationalUnit($organizationalUnit: OrganizationalUnitInput!) {\n organizationalUnitQuery {\n organizationalUnit(organizationalUnit: $organizationalUnit) {\n __typename\n ... on OrganizationalUnitNotFoundError {\n __typename\n message\n }\n ... on Organization {\n __typename\n ...OrganizationFragment\n }\n ... on Site {\n __typename\n ...SiteFragment\n }\n ... on Department {\n __typename\n ...DepartmentFragment\n }\n }\n }\n}\n\nfragment OrganizationFragment on Organization {\n id\n name\n imageURL\n createdAt\n termsOfServiceURL\n privacyPolicyURL\n allowInvites\n\n sites {\n __typename\n ...SiteFragment\n }\n}\n\nfragment SiteFragment on Site {\n id\n name\n createdAt\n}\n\nfragment DepartmentFragment on Department {\n id\n name\n createdAt\n}","variables":"{\n\t\"organizationalUnit\": {\n\t\t\"id\": {{organizationId}},\n\t\t\"type\": \"organization\"\n\t}\n}"}},"url":"https://{{api_hostname}}/v2/graphql/private"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Mar 2024 21:51:01 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1323"},{"key":"Connection","value":"keep-alive"},{"key":"X-Request-Id","value":"7bb24e52-7a45-4a96-ac1e-72105a20c42b"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Surrogate-Control","value":"no-store"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, proxy-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=5184000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"organizationalUnitQuery\": {\n \"organizationalUnit\": {\n \"__typename\": \"Organization\",\n \"id\": \"1\",\n \"name\": \"Hypercare\",\n \"imageURL\": null,\n \"createdAt\": \"2022-05-19T04:05:05.000Z\",\n \"termsOfServiceURL\": \"https://www.hypercare.com/terms-of-service\",\n \"privacyPolicyURL\": \"https://www.hypercare.com/privacy-policy\",\n \"allowInvites\": true,\n \"sites\": [\n {\n \"__typename\": \"Site\",\n \"id\": \"1\",\n \"name\": \"Toronto Office\",\n \"createdAt\": \"2022-05-19T04:40:05.000Z\"\n },\n {\n \"__typename\": \"Site\",\n \"id\": \"3\",\n \"name\": \"Montreal Office\",\n \"createdAt\": \"2022-05-19T17:07:17.000Z\"\n }\n ]\n }\n }\n }\n}"}],"_postman_id":"1557e1f1-b756-46ec-8f58-ba4aefc06c12"},{"name":"Fetch All Sites and Departments for Organization","event":[{"listen":"test","script":{"id":"ed546556-9574-47e5-ab7a-b7609da3a8b2","exec":["let jsonBody = pm.response.json();","var response = jsonBody.data.me;"," ","pm.test(\"get number of organizations\", function(){"," let org = response.organizations.length;"," console.log(\"number of organizations are:\", org);"," ","})"," pm.test(\"get the names of the organizations\", function(){"," console.log(\"the organizations are:\")"," for(var i=0;i@return a list of all your organizations
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_bearer}}"}]},"isInherited":true,"source":{"_postman_id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","name":"Private (Authenticated)","type":"folder"}},"urlObject":{"protocol":"https","path":["v2","graphql","private"],"host":["{{api_hostname}}"],"query":[],"variable":[]}},"response":[{"id":"609c314f-9304-4c55-9f97-9cfe7a443472","name":"Success Sample Response","originalRequest":{"method":"POST","header":[{"key":"hypercare-scope","value":"{{scopetoken}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query GetOrganizationalUnit($organizationalUnit: OrganizationalUnitInput!) {\n organizationalUnitQuery {\n organizationalUnit(organizationalUnit: $organizationalUnit) {\n __typename\n ... on OrganizationalUnitNotFoundError {\n __typename\n message\n }\n ... on Organization {\n __typename\n ...OrganizationFragment\n }\n ... on Site {\n __typename\n ...SiteFragment\n }\n ... on Department {\n __typename\n ...DepartmentFragment\n }\n }\n }\n}\n\nfragment OrganizationFragment on Organization {\n id\n name\n imageURL\n createdAt\n termsOfServiceURL\n privacyPolicyURL\n allowInvites\n\n sites {\n __typename\n ...SiteFragment\n }\n}\n\nfragment SiteFragment on Site {\n id\n name\n createdAt\n\n departments {\n __typename\n ...DepartmentFragment\n }\n}\n\nfragment DepartmentFragment on Department {\n id\n name\n createdAt\n}","variables":"{\n\t\"organizationalUnit\": {\n\t\t\"id\": {{organizationId}},\n\t\t\"type\": \"organization\"\n\t}\n}"}},"url":"https://{{api_hostname}}/v2/graphql/private"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Mar 2024 21:53:05 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"3831"},{"key":"Connection","value":"keep-alive"},{"key":"X-Request-Id","value":"c129a954-62c2-4021-bf6b-5d6674225644"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Surrogate-Control","value":"no-store"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, proxy-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=5184000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"organizationalUnitQuery\": {\n \"organizationalUnit\": {\n \"__typename\": \"Organization\",\n \"id\": \"1\",\n \"name\": \"Hypercare\",\n \"imageURL\": null,\n \"createdAt\": \"2022-05-19T04:05:05.000Z\",\n \"termsOfServiceURL\": \"https://www.hypercare.com/terms-of-service\",\n \"privacyPolicyURL\": \"https://www.hypercare.com/privacy-policy\",\n \"allowInvites\": true,\n \"sites\": [\n {\n \"__typename\": \"Site\",\n \"id\": \"1\",\n \"name\": \"Toronto Office\",\n \"createdAt\": \"2022-05-19T04:40:05.000Z\",\n \"departments\": [\n {\n \"__typename\": \"Department\",\n \"id\": \"1\",\n \"name\": \"Engineering\",\n \"createdAt\": \"2022-05-19T04:39:28.000Z\"\n },\n {\n \"__typename\": \"Department\",\n \"id\": \"2\",\n \"name\": \"Sales\",\n \"createdAt\": \"2022-05-19T04:39:44.000Z\"\n },\n {\n \"__typename\": \"Department\",\n \"id\": \"3\",\n \"name\": \"Customer Success\",\n \"createdAt\": \"2022-05-19T04:39:51.000Z\"\n }\n ]\n },\n {\n \"__typename\": \"Site\",\n \"id\": \"3\",\n \"name\": \"Montreal Office\",\n \"createdAt\": \"2022-05-19T17:07:17.000Z\",\n \"departments\": [\n {\n \"__typename\": \"Department\",\n \"id\": \"6\",\n \"name\": \"Marketing\",\n \"createdAt\": \"2022-05-19T17:08:03.000Z\"\n },\n {\n \"__typename\": \"Department\",\n \"id\": \"7\",\n \"name\": \"HR\",\n \"createdAt\": \"2022-05-19T17:08:07.000Z\"\n },\n {\n \"__typename\": \"Department\",\n \"id\": \"13\",\n \"name\": \"Engineering\",\n \"createdAt\": \"2023-05-05T15:55:52.000Z\"\n }\n ]\n }\n ]\n }\n }\n }\n}"}],"_postman_id":"0cf282d2-701e-4659-bcff-06a9054b999c"}],"id":"d3fbe0dd-fae1-4846-95d5-64f59e01eacb","description":"This section contains functionalities accessable to all users with and without administrator privileges.
\n","_postman_id":"d3fbe0dd-fae1-4846-95d5-64f59e01eacb","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_bearer}}"}]},"isInherited":true,"source":{"_postman_id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","name":"Private (Authenticated)","type":"folder"}}}],"id":"ee861d48-6630-4d9f-8099-1d64402dbfcb","description":"This section will provide developers with all the necessary information to integrate into Hypercare's organizational unit management features. An organizational unit can be the organization, site, or department of an institution. Through our GraphQL API, you'll have the capability to structure and manipulate organizational hierarchical data, ranging from user invites and permissions, site and departmental structures, and unit wide analytics.
\n","_postman_id":"ee861d48-6630-4d9f-8099-1d64402dbfcb","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_bearer}}"}]},"isInherited":true,"source":{"_postman_id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","name":"Private (Authenticated)","type":"folder"}}},{"name":"User","item":[{"name":"Admin","item":[{"name":"Addresses","item":[{"name":"Add Addresses","id":"c348e508-fcd1-4cb6-8000-b49fcbf6a2b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"hypercare-scope","value":"{{scopetoken}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation AddAddresses($organizationalUnit: OrganizationalUnitInput!, $id: ID!, $addresses: [CreateAddressInput!]!) {\n adminMutation {\n ... on AdminMutation {\n organizationalUnit(organizationalUnit: $organizationalUnit) {\n ... on AdminOrganizationMutation {\n member(id: $id) {\n ... on UserNotFoundError {\n __typename\n message\n }\n ... on FullOrganizationMemberMutation {\n addAddresses(addresses: $addresses) {\n __typename\n ... on AdminAddAddressesResponse {\n addresses {\n __typename\n ... on Address {\n address\n type\n organization {\n id\n name\n }\n syncStatus\n label\n createdAt\n updatedAt\n }\n ... on AddressInUse { \n __typename \n message \n }\n ... on UserNotFoundError { \n __typename \n message \n }\n }\n }\n }\n }\n }\n }\n }\n }\n }\n}","variables":"{\n \"organizationalUnit\": {\n \"type\": \"organization\",\n \"id\": {{organizationId}}\n },\n \"id\": \"{{userId}}\",\n \"addresses\": [\n {\n \"address\": \"email@test.com\",\n \"type\": \"email\",\n \"access\": \"public\"\n },\n {\n \"address\": \"+16471234567\",\n \"type\": \"phoneNumber\",\n \"access\": \"private\"\n },\n {\n \"address\": \"9051234567\",\n \"type\": \"alphanumeric_pager\",\n \"access\": \"public\"\n }\n ]\n}"}},"url":"{{api_host_protocol}}{{api_hostname}}/v2/graphql/private","description":"GraphQL mutation for admins to add an array of addresses and their properties to the given user. Results will be returned for each added address individually, in the inputted order.
\norganizationalUnit (Object)
id (String): The ID of the organizational unit in context
type (String): Organization unit type (e.g. \"organization\", \"site\", \"department\")
id (String): The ID of the user to whom addresses are being added
addresses (Object): An array of address objects to be added to the given user
address (String): The address to be added
type (String): The type of the address (e.g. \"phoneNumber\", \"email\", \"pager\", \"alphanumberic_pager\")
access (String): The access type of the address. Public addresses can be viewed by all members of the organization, private addresses are visiable to the admin only (e.g. \"public\", \"private\")
OrganizationalUnitNotFoundError: The organization ID provided does not correspond to an existing organization
UserNotAdminForScope: User is not an admin of the organizational unit they are checking against
AddressInUse: One or more addresses are linked with an existing user in the organization
UserNotFound: The given user ID does not corespond to any users in the organization
GraphQL mutation that allows admins to remove an array of addresses from a given user. Results will be returned for each removed address individually, in the inputted order.
\norganizationalUnit (Object)
id (String): The ID of the organizational unit in context
type (String): Organization unit type (e.g. \"organization\", \"site\", \"department\")
id (String): The ID of the user to whom addresses are being removed
addressIds ([String]): An array of base64 encoded addresses to be removed from the given user
OrganizationalUnitNotFoundError: The organization ID provided does not correspond to an existing organization
UserNotAdminForScope: User is not an admin of the organizational unit they are checking against
AddressNotOwnedByUser: The address to be removed does not belong to the user
UserNotFound: The given user ID does not corespond to any users in the organization
GraphQL mutation for admins to update the access permissions for a specific address for a given user
\norganizationalUnit (Object)
id (String): The ID of the organizational unit in context
type (String): Organization unit type (e.g. \"organization\", \"site\", \"department\")
id (String): The ID of the user to be updated
address (String): The address to be updated
access (String): The new access (e.g. \"public\", \"private\")
OrganizationalUnitNotFoundError: The organization ID provided does not correspond to an existing organization
UserNotAdminForScope: User is not an admin of the organizational unit they are checking against
AddressNotOwnedByUser: The address to be removed does not belong to the user
UserNotFound: The given user ID does not corespond to any users in the organization
GraphQL mutation for admins to update the label for a specific address for a given user
\norganizationalUnit (Object)
id (String): The ID of the organization for which pending invites are being retrieved
type (String): Organization unit type (e.g. \"organization\", \"site\", \"department\")
id (String): The ID of the user to be updated
address (String): The address to be updated
label (String): The new address label (e.g. \"work\", \"home\", etc, as determined by your organization)
OrganizationalUnitNotFoundError: The organization ID provided does not correspond to an existing organization
UserNotAdminForScope: User is not an admin of the organizational unit they are checking against
AddressNotOwnedByUser: The address to be removed does not belong to the user
UserNotFound: The given user ID does not corespond to any users in the organization
GraphQL mutation for admins to update the ordering of the addresses as they are shown on a user's profile
\norganizationalUnit (Object)
id (String): The ID of the organization for which pending invites are being retrieved
type (String): Organization unit type (e.g. \"organization\", \"site\", \"department\")
id (String): The ID of the user to be updated
address ([String]): An array of addresses in the order to be displayed on the user's profile
OrganizationalUnitNotFoundError: The organization ID provided does not correspond to an existing organization
UserNotAdminForScope: User is not an admin of the organizational unit they are checking against
UserNotFound: The given user ID does not corespond to any users in the organization
InvalidAddressUpdateRequest: The request is invalid or misformed
DuplicateAddresses: One or more of the inputted address is a duplicate
GraphQL query that returns all profile fields for a given user
\norganizationalUnit (Object)
id (String): The ID of the organizational unit in context
type (String): Organization unit type (e.g. \"organization\", \"site\", \"department\")
userId (String): The ID of the user to be updated
OrganizationalUnitNotFoundError: The organization ID provided does not correspond to an existing organization
UserNotAdminForScope: User is not an admin of the organizational unit they are checking against
UserNotFound: The given user ID does not corespond to any users in the organization
GraphQL mutation for admins to create a new profile note for a given user
\norganizationalUnit (Object)
id (String): The ID of the organizational unit in context
type (String): Organization unit type (e.g. \"organization\", \"site\", \"department\")
userId (String): The ID of the user to be updated
details (Object):
note (String)
access(String): The visiability of the note, where public is viewable by anyone in the organization, and private is only visiable to admins and the user themselves (e.g. \"public\", \"private\")
OrganizationalUnitNotFoundError: The organization ID provided does not correspond to an existing organization
UserNotAdminForScope: User is not an admin of the organizational unit they are checking against
UserNotFound: The given user ID does not corespond to any users in the organization
ExceedMaxNoteCountError: A user can have maximum number of 25 notes
ExceedMaxWordCountError: A note cannot be more than 1000 characters long
GraphQL mutation for admins to update an existing profile note for a given user
\norganizationalUnit (Object)
id (String): The ID of the organizational unit in context
type (String): Organization unit type (e.g. \"organization\", \"site\", \"department\")
userId (String): The ID of the user to be updated
noteId (String): The ID of the note to be updated
details (Object):
note (String)
access(String): The visiability of the note, where public is viewable by anyone in the organization, and private is only visiable to admins and the user themselves (e.g. \"public\", \"private\")
OrganizationalUnitNotFoundError: The organization ID provided does not correspond to an existing organization
UserNotAdminForScope: User is not an admin of the organizational unit they are checking against
UserNotFound: The given user ID does not corespond to any users in the organization
AccessForbiddenError: You do not have access to update this note
NoteNotFoundError: The note being udpated does not exist
NoteDeletedError: Cannot update archived notes
ExceedMaxNoteCountError: A user can have maximum number of 25 notes
ExceedMaxWordCountError: A note cannot be more than 1000 characters long
GraphQL mutation for admins to delete an existing profile note for a given user
\norganizationalUnit (Object)
id (String): The ID of the organizational unit in context
type (String): Organization unit type (e.g. \"organization\", \"site\", \"department\")
userId (String): The ID of the user to be updated
noteId (String): The ID of the note to be deleted
OrganizationalUnitNotFoundError: The organization ID provided does not correspond to an existing organization
UserNotAdminForScope: User is not an admin of the organizational unit they are checking against
UserNotFound: The given user ID does not corespond to any users in the organization
AccessForbiddenError: You do not have access to update this note
NoteNotFoundError: The note being udpated does not exist
NoteDeletedError: Cannot update archived notes
GraphQL query for admins to fetch a specific profile note by ID for a given user
\norganizationalUnit (Object)
id (String): The ID of the organizational unit in context
type (String): Organization unit type (e.g. \"organization\", \"site\", \"department\")
id (String): The ID of the user
noteId (String): The ID of the note
OrganizationalUnitNotFoundError: The organization ID provided does not correspond to an existing organization
UserNotAdminForScope: User is not an admin of the organizational unit they are checking against
UserNotFound: The given user ID does not corespond to any users in the organization
NoteNotFoundError: The note being udpated does not exist
NoteDeletedError: Cannot update archived notes
GraphQL query for admins to fetch all profile note for a given user. Admins have access to both public and private notes for users
\norganizationalUnit (Object)
id (String): The ID of the organizational unit in context
type (String): Organization unit type (e.g. \"organization\", \"site\", \"department\")
id (String): The ID of the user
OrganizationalUnitNotFoundError: The organization ID provided does not correspond to an existing organization
UserNotAdminForScope: User is not an admin of the organizational unit they are checking against
UserNotFound: The given user ID does not corespond to any users in the organization
GraphQL query for admins to fetch a list of all devices a user is logged in to.
\nPossible devices types: DeviceType { ios android web}
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_bearer}}"}]},"isInherited":true,"source":{"_postman_id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","name":"Private (Authenticated)","type":"folder"}},"urlObject":{"protocol":"https","path":["v2","graphql","private"],"host":["{{api_hostname}}"],"query":[],"variable":[]}},"response":[{"id":"81621730-8eee-49df-8abe-95e52f8a5a9c","name":"Fetch User Devices","originalRequest":{"method":"GET","header":[{"key":"hypercare-scope","value":"{{scopetoken}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query FetchUser($userId: ID!) {\n adminQuery {\n ... on AdminQuery {\n user(id: $userId) {\n ... on Node { id }\n ... on GeneralUser {\n firstName\n lastName\n username\n }\n ... on FullOrganizationMember {\n devices {\n id\n type\n pushToken\n pushService\n ... on BrowserDevice {\n browser\n }\n }\n }\n }\n }\n }\n}","variables":"{\n \"userId\": \"2b881170-5b6d-11e7-a17b-2d997b30f468\"\n}"}},"url":"https://{{api_hostname}}/v2/graphql/private"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 23 Apr 2024 13:39:05 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1977"},{"key":"Connection","value":"close"},{"key":"X-Request-ID","value":"b67b05f0-6c19-454c-9e61-70c6da78ec10"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Surrogate-Control","value":"no-store"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, proxy-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=5184000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"adminQuery\": {\n \"user\": {\n \"id\": \"2b881170-5b6d-11e7-a17b-2d997b30f468\",\n \"firstName\": \"Test\",\n \"lastName\": \"User\",\n \"username\": \"user001\",\n \"devices\": [\n {\n \"id\": \"42FA471C-2027-4F6A-A423-8C19C76A87E3\",\n \"type\": \"ios\",\n \"pushToken\": \"277cdk78cjhkewnm8986756ds980jksl134ba7034ff64f3a2e3406c059730e3\",\n \"pushService\": \"apns\"\n },\n {\n \"id\": \"15319B23-05A3-4CB9-AC81-785AEBFD6FA5\",\n \"type\": \"ios\",\n \"pushToken\": \"3715e16771dc0c3a850a120628a10a89sd89lktkj23nm2dd062e13\",\n \"pushService\": \"apns\"\n },\n {\n \"id\": \"8d9969f9-f807-478a-9453-58fbf824e9c3\",\n \"type\": \"android\",\n \"pushToken\": \"e84gJnkjdshKJkwOc2:APA91bFOhmnrKlzg9fmgPCphX0bkjoLneW5HYqcIveqtAOl8lRZ9hocAzySJcEDOBD6oqHNr4PrXj5IrBh1dYc6lPZIJQ5gXtDRb7876ds9kjhcFm7832mwDUh_4g2nMY-\",\n \"pushService\": \"fcm\"\n }\n ]\n }\n }\n }\n}"}],"_postman_id":"cbe9ef4d-a49b-4bf3-8341-a2cd1568e5ba"},{"name":"Remote Logout All Devices","id":"b5bbfb23-981e-4913-ad25-dd65bc4ee4f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"hypercare-scope","value":"{{scopetoken}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation Member($id: ID!, $organizationalUnit: OrganizationalUnitInput!) {\n adminMutation {\n ... on AdminMutation {\n organizationalUnit(organizationalUnit: $organizationalUnit) {\n ... on AdminOrganizationMutation {\n member(id: $id) {\n ... on FullOrganizationMemberMutation {\n remoteLogoutAllDevices {\n id\n }\n }\n ... on Error { __typename message }\n }\n }\n ... on Error { __typename message }\n }\n }\n ... on Error { __typename message }\n }\n}","variables":"{\n \"organizationalUnit\": {\n \"id\": {{organizationId}},\n \"type\": \"organization\"\n },\n \"id\": {{userId}}\n}"}},"url":"{{api_host_protocol}}{{api_hostname}}/v2/graphql/private","description":"GraphQL mutation that allows admins to remotely log a user out of all their active devices.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_bearer}}"}]},"isInherited":true,"source":{"_postman_id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","name":"Private (Authenticated)","type":"folder"}},"urlObject":{"path":["v2","graphql","private"],"host":["{{api_host_protocol}}{{api_hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b5bbfb23-981e-4913-ad25-dd65bc4ee4f4"}],"id":"a31f79e3-504a-48ef-a27f-3227238c9e3b","_postman_id":"a31f79e3-504a-48ef-a27f-3227238c9e3b","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_bearer}}"}]},"isInherited":true,"source":{"_postman_id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","name":"Private (Authenticated)","type":"folder"}}},{"name":"Fetch Member & Address Info","id":"9d2f6f0a-1f8b-40ab-a7d2-fea6f6a0ca3f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"hypercare-scope","value":"{{scopetoken}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query FetchMemberAndAddresses($organizationalUnit: OrganizationalUnitInput!, $userId: ID!) {\n adminQuery {\n __typename\n ... on UserNotAdminForScope {\n __typename\n message\n }\n ... on AdminQuery { \n organizationalUnit(organizationalUnit: $organizationalUnit) {\n ... on OrganizationalUnitNotFoundError {\n __typename\n message\n }\n ... on AdminOrganizationQuery {\n __typename\n member(id: $userId) {\n __typename\n ... on UserNotFoundError {\n message\n }\n ...FullOrganizationUserResultFragment\n }\n }\n ... on AdminSiteQuery {\n __typename\n member(id: $userId) {\n __typename\n ... on UserNotFoundError {\n message\n }\n ...FullOrganizationUserResultFragment\n }\n }\n ... on AdminDepartmentQuery {\n __typename\n member(id: $userId) {\n __typename\n ... on UserNotFoundError {\n message\n }\n ...FullOrganizationUserResultFragment\n }\n }\n }\n }\n }\n}\n\nfragment FullOrganizationUserResultFragment on FullOrganizationUserResult {\n ... on GeneralUser {\n ...GeneralUserFragment\n }\n ... on Node {\n id\n }\n ... on FullOrganizationMember {\n id\n firstName\n lastName\n role\n isDirectorySynced\n isSSOEnabled\n addresses {\n id\n address\n ordinal\n type\n label\n verified\n access\n syncStatus\n createdAt\n updatedAt\n }\n }\n}\n\nfragment GeneralUserFragment on GeneralUser {\n username\n firstName\n lastName\n}","variables":"{\n \"organizationalUnit\": {\n\t\t\"id\": {{organizationId}},\n\t\t\"type\": \"organization\"\n\t},\n \"userId\": \"{{userId}}\"\n}"}},"url":"{{api_host_protocol}}{{api_hostname}}/v2/graphql/private","description":"GraphQL query for admins to fetche a user's address and profile information
\norganizationalUnit (Object)
id (String): The ID of the organizational unit in context
type (String): Organization unit type (e.g. \"organization\", \"site\", \"department\")
userId (String): The ID of the user
OrganizationalUnitNotFoundError: The organization ID provided does not correspond to an existing organization
UserNotAdminForScope: User is not an admin of the organizational unit they are checking against
UserNotFound: The given user ID does not corespond to any users in the organization
GraphQL query for admins to fetch a user's scope and status within an organizational unit scope
\norganizationalUnit (Object)
id (String): The ID of the organizational unit in context
type (String): Organization unit type (e.g. \"organization\", \"site\", \"department\")
userId (String): The ID of the user
UserNotFound: The given user ID does not corespond to any users in the organizationGraphQL query for admins to fetch a user's shifts within a given time frame
\nuserId (String): The ID of the user
startDate: The starting datetime range of the shifts to be fetched
endDate: The ending datetime range of the shifts to be fetched
UserNotFound: The given user ID does not corespond to any users in the organizationGraphQL mutation for admins to update a user's profile information, such as their first name, last name, and job title
\norganizationalUnit (Object)
id (String): The ID of the organizational unit in context
type (String): Organization unit type (e.g. \"organization\", \"site\", \"department\")
userId (String): The ID of the user
details(Object):
firstName(String)
lastName(String)
role(String): Job title of the user
OrganizationalUnitNotFoundError: The organization ID provided does not correspond to an existing organization
UserNotAdminForScope: User is not an admin of the organizational unit they are checking against
UserNotFound: The given user ID does not corespond to any users in the organization
GraphQL mutation for admins to update the ways a user is allowed to log into the organization. The loginMethods passed in replaces the user's current login methods
organizationalUnit (Object)
id (String): The ID of the organizational unit in context
type (String): Organization unit type (e.g. \"organization\", \"site\", \"department\")
userId (String): The ID of the user
loginMethods([String]): Array of possible login methods for the user (e.g. \"otp\", \"password\", \"sso\")
OrganizationalUnitNotFoundError: The organization ID provided does not correspond to an existing organization
UserNotAdminForScope: User is not an admin of the organizational unit they are checking against
UserNotFound: The given user ID does not corespond to any users in the organization
InvalidLoginMethodError: One or more of the given login methods are misformed
GraphQL mutation for admins to add a user to a specific site or department within an organization
\norganizationalUnit (Object)
id (String): The ID of the organizational unit in context
type (String): Organization unit type (e.g. \"organization\", \"site\", \"department\")
id (String): The ID of the user to be added to the scope
OrganizationalUnitNotFoundError: The organization ID provided does not correspond to an existing organization
UserNotAdminForScope: User is not an admin of the organizational unit they are checking against
UserAlreadyExistsForScope : User is already a part of the given scope
GraphQL mutation for admins to demote a user from admin to regular user for an array of given scopes
\norganizationalUnit (Object)
id (String): The ID of the organizational unit in context
type (String): Organization unit type (e.g. \"organization\", \"site\", \"department\")
userId (String): The ID of the user to be demoted
scopes ([Object]): The specific scopes which the user will be demoted from
organizationId (Int)
siteId (Int)
departmentId (Int)
OrganizationalUnitNotFoundError: The organization ID provided does not correspond to an existing organization
UserNotAdminForScope: User is not an admin of the organizational unit they are checking against
Remove user from given scope. If no scope is specified in requests it inherits the scope of the requesting user.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_bearer}}"}]},"isInherited":true,"source":{"_postman_id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","name":"Private (Authenticated)","type":"folder"}},"urlObject":{"protocol":"https","path":["graphql","private"],"host":["{{api_hostname}}"],"query":[],"variable":[]}},"response":[{"id":"66a2d5b2-4eab-478a-85d6-620e13082aef","name":"Success Sample Response - Remove User from Organization","originalRequest":{"method":"POST","header":[{"key":"hypercare-scope","value":"{{scopetoken}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation removeUser($userId: ID!, $scope: OrganizationScopeInput) {\n admin {\n user(id: $userId) {\n remove(scope: $scope) {\n ...FullUserFragment\n }\n }\n }\n}\n\nfragment FullUserFragment on FullUser {\n id\n username\n firstname\n lastname\n addresses {\n id\n address\n type\n }\n joinDate\n status\n}","variables":"{\n \"userId\": \"70f598af-6899-4d0e-8c97-bab2f4b7b7cd\",\n \"scope\": {\n \"organizationId\": 1\n }\n}"}},"url":"{{api_host_protocol}}{{api_hostname}}/graphql/private"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Surrogate-Control","value":"no-store"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, proxy-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=5184000; includeSubDomains"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"362"},{"key":"Date","value":"Mon, 02 Oct 2023 14:19:38 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"admin\": {\n \"user\": {\n \"remove\": {\n \"id\": \"70f598af-6899-4d0e-8c97-bab2f4b7b7cd\",\n \"username\": \"deleteusertest1\",\n \"firstname\": \"Test\",\n \"lastname\": \"Logging2\",\n \"addresses\": [],\n \"joinDate\": \"1990-01-01T00:00:00.000Z\",\n \"status\": \"active\"\n }\n }\n }\n }\n}"}],"_postman_id":"e6a13d53-438b-415f-9a57-dc78fb8735ef"},{"name":"Archive Member","id":"dc1f470e-03cc-4965-be94-a828576fd80d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"graphql","graphql":{"query":"mutation ArchiveMember($userId: ID!, $organizationalUnit: OrganizationalUnitInput!) {\n adminMutation {\n ... on AdminMutation {\n organizationalUnit(organizationalUnit: $organizationalUnit) {\n ... on AdminOrganizationMutation {\n member(id: $userId) {\n __typename\n ... on FullOrganizationMemberMutation {\n archive {\n __typename\n ...FullOrganizationMemberFragment\n ... on Error {\n message\n }\n }\n }\n }\n }\n }\n }\n }\n}\n\nfragment FullOrganizationMemberFragment on FullOrganizationMember {\n id\n firstName\n lastName\n role\n}","variables":"{\n \"organizationalUnit\": {\n \"type\": \"organization\",\n \"id\": {{organizationId}}\n },\n \"userId\": {{userId}}\n}"}},"url":"{{api_host_protocol}}{{api_hostname}}/v2/graphql/private","description":"GraphQL mutation for admins to archive a removed user, so they will no longer be returned in the removed users list
\norganizationalUnit (Object)
id (String): The ID of the organizational unit in context
type (String): Organization unit type (e.g. \"organization\", \"site\", \"department\")
userId (String): The ID of the user
OrganizationalUnitNotFoundError: The organization ID provided does not correspond to an existing organization
UserNotAdminForScope: User is not an admin of the organizational unit they are checking against
UserNotFound: The given user ID does not corespond to any users in the organization
This section contains functionalities only accessable to users with administrator privileges. The error UserNotAdminForScope will return for all unauthorized access.
GraphQL query for fetching a user's information within a given organizational unit
\norganizationalUnit (Object)
id (String): The ID of the organizational unit in context
type (String): Organization unit type (e.g. \"organization\", \"site\", \"department\")
userId(String): The ID of the user
id, firstName, lastName, role, workStatus, isDirectorySynced, joinDate, publicnotes, public address, etcOrganizationalUnitNotFoundError: The organization ID provided does not correspond to an existing organization
UserNotFound: The given user ID does not corespond to any users in the organization
GraphQL query for fetching a user's current on-call information
\norganizationalUnit (Object)
id (String): The ID of the organizational unit in context
type (String): Organization unit type (e.g. \"organization\", \"site\", \"department\")
userId(String): The ID of the user
onCallNow information, which contains the role and department they are currently on-call forOrganizationalUnitNotFoundError: The organization ID provided does not correspond to an existing organization
UserNotFound: The given user ID does not corespond to any users in the organization
GraphQL query for fetching a user's information within a given organizational unit
\norganizationalUnit (Object)
id (String): The ID of the organizational unit in context
type (String): Organization unit type (e.g. \"organization\", \"site\", \"department\")
userId(String): The ID of the user
OrganizationalUnitNotFoundError: The organization ID provided does not correspond to an existing organization
UserNotFound: The given user ID does not corespond to any users in the organization
GraphQL query for users to fetch a specific profile note by ID for a given user
\norganizationalUnit (Object)
id (String): The ID of the organizational unit in context
type (String): Organization unit type (e.g. \"organization\", \"site\", \"department\")
id (String): The ID of the user
noteId (String): The ID of the note
OrganizationalUnitNotFoundError: The organization ID provided does not correspond to an existing organization
AccessForbiddenError: You do not have access to this note
UserNotFound: The given user ID does not corespond to any users in the organization
NoteNotFoundError: The note being udpated does not exist
NoteDeletedError: Cannot update archived notes
GraphQL query for users to fetch all public profile note for a given user. Non-admin users will only have access to public notes on another user's profile.
\norganizationalUnit (Object)
id (String): The ID of the organizational unit in context
type (String): Organization unit type (e.g. \"organization\", \"site\", \"department\")
id (String): The ID of the user
OrganizationalUnitNotFoundError: The organization ID provided does not correspond to an existing organization
UserNotAdminForScope: User is not an admin of the organizational unit they are checking against
UserNotFound: The given user ID does not corespond to any users in the organization
This section contains functionalities accessable to all users with and without administrator privileges.
\n","_postman_id":"67da69ec-1489-4970-bd8a-7e9f5fe1dbdc","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_bearer}}"}]},"isInherited":true,"source":{"_postman_id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","name":"Private (Authenticated)","type":"folder"}}},{"name":"Self","item":[{"name":"Address","item":[{"name":"Add Address","id":"79529449-2e6a-4d93-b088-c9efd72588a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"hypercare-scope","value":"{{scopetoken}}"}],"body":{"mode":"graphql","graphql":{"query":"mutation AddAddress($challengeId: String!, $addressDetails: AddressDetails!) {\n selfMutation {\n addAddress(challengeId: $challengeId, details: $addressDetails) {\n __typename\n ... on Address {\n address\n type\n label\n access\n id\n ordinal\n }\n ... on DomainBoundAddress {\n organization {\n id\n name\n }\n domain\n }\n ... on InvalidAddressLabel {\n message\n }\n ... on ChallengeNotFound {\n message\n }\n ... on ChallengeNotCompleted {\n message\n }\n ... on ChallengeFailed {\n message\n }\n ... on AddressInUse {\n message\n }\n ... on DuplicateAddresses {\n message\n }\n }\n }\n}","variables":"{\n \"challengeId\": {{challengeId}},\n \"addressDetails\": {\n \"label\": null,\n \"access\": \"public\"\n }\n}"}},"url":"{{api_host_protocol}}{{api_hostname}}/v2/graphql/private","description":"GraphQL mutation for a user to add an address to their own profile. The user first have to successfully verify their ownership of the address, which will then provide them with a challengeId associated with the now verified address.
challengeId (String): Obtained after successfully verifying ownership of the address
addressDetails (Object):
label (String, optional): The new address label (e.g. \"work\", \"home\", etc, as determined by your organization)
access (String, optional): The access type of the address. Public addresses can be viewed by all members of the organization, private addresses are visiable to the admin only (e.g. \"public\", \"private\")
ChallengeNotFound: Invalid challengeId
ChallengeFailed: Address verification failed
ChallengeNotCompleted: Address verification process not completed
AddressInUse: The address is already associated with an existing user in the organization
DuplicateAddresses: The address is already associated with the user
InvalidAddressLabel: Invalid address label given
GraphQL mutation for a user to remove an address from their own profile.
\naddress (String): The address to be removedAddressNotFound: The address being removed is not foundGraphQL mutation for a user to update the label for a specific address
\naddress (String): The address to be updated
label (String): The new address label (e.g. \"work\", \"home\", etc, as determined by your organization)
AddressNotFound: Cannot find the given address for user
InvalidAddressLabel: Invalid label passed in
GraphQL mutation for a user to update the access for a specific address
\naddress (String): The address to be updated
access (String, optional): The access type of the address. Public addresses can be viewed by all members of the organization, private addresses are visiable to the admin only (e.g. \"public\", \"private\")
AddressNotFound: Cannot find the given address for userGraphQL mutation to update the ordering of the addresses as they are shown on the user's profile
\naddress ([String]): An array of addresses in the order to be displayed on the user's profileInvalidAddressUpdateRequest: The request is invalid or misformed
DuplicateAddresses: One or more of the inputted address is a duplicate
GraphQL mutation for adding an unverified address to the user's profile. Unverified address will not be displayed on their profile, and currently cannot be interacted with.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_bearer}}"}]},"isInherited":true,"source":{"_postman_id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","name":"Private (Authenticated)","type":"folder"}},"urlObject":{"path":["v2","graphql","private"],"host":["{{api_host_protocol}}{{api_hostname}}"],"query":[],"variable":[]}},"response":[{"id":"2cba6ba1-869c-4921-8d0f-c7a06a30e586","name":"Success","originalRequest":{"method":"POST","header":[{"key":"hypercare-scope","value":"{{scopetoken}}"}],"body":{"mode":"graphql","graphql":{"query":"mutation AddUnverifiedAddress($details: UnverifiedAddressDetails!) {\n selfMutation {\n addUnverifiedAddress(details: $details) {\n ... on InvalidAddress {\n __typename\n message\n }\n ... on AddressInUse {\n __typename\n message\n }\n ... on Address {\n __typename\n id\n address\n type\n }\n }\n }\n}","variables":"{\n \"details\": {\n \"address\": \"testaddunverified001@gmail.com\",\n \"type\": \"email\"\n }\n}"}},"url":"{{api_host_protocol}}{{api_hostname}}/v2/graphql/private"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Request-ID","value":"9eb3faa1-28fc-485e-a8ed-d43eebbe5266"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Surrogate-Control","value":"no-store"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, proxy-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=5184000; includeSubDomains"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"281"},{"key":"Date","value":"Mon, 23 Sep 2024 18:45:51 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"selfMutation\": {\n \"addUnverifiedAddress\": {\n \"__typename\": \"Address\",\n \"id\": \"bW9zdXNpZXl1K3Rlc3RhZGR1bnZlcmlmaWVkMDAxQGdtYWlsLmNvbQ==\",\n \"address\": \"testaddunverified001@gmail.com\",\n \"type\": \"email\"\n }\n }\n }\n}"}],"_postman_id":"8c62f1e6-8735-4a45-b882-a10c45356334"}],"id":"0b4a6559-a435-4e26-a271-d20903ada864","_postman_id":"0b4a6559-a435-4e26-a271-d20903ada864","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_bearer}}"}]},"isInherited":true,"source":{"_postman_id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","name":"Private (Authenticated)","type":"folder"}}},{"name":"Session","item":[{"name":"Remove Session by ID","id":"af81ced3-7a5d-4e96-b3e8-e1025328226f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"graphql","graphql":{"query":"mutation SessionMutationResult ($sessionId: ID!) {\n selfMutation {\n session(id: $sessionId) {\n ... on SessionNotFound {\n __typename\n message\n }\n ... on SessionMutation {\n remove {\n ... on FullOrganizationMember {\n id\n }\n }\n }\n }\n }\n}","variables":"{\n \"sessionId\": {{sessionId}}\n}"}},"url":"{{api_host_protocol}}{{api_hostname}}/v2/graphql/private","description":"GraphQL mutation for a user to remove a session by ID
\nSessionNotFoundGraphQL mutation for users to create a new profile note on their own profile
\ndetails (Object):
note (String)
access(String): The visiability of the note, where public is viewable by anyone in the organization, and private is only visiable to admins and the user themselves (e.g. \"public\", \"private\")
ExceedMaxNoteCountError: A user can have maximum number of 25 notes
ExceedMaxWordCountError: A note cannot be more than 1000 characters long
GraphQL mutation for users to update an existing profile note on their profile
\nnoteId (String): The ID of the note to be updated
details (Object):
note (String)
access(String): The visiability of the note, where public is viewable by anyone in the organization, and private is only visiable to admins and the user themselves (e.g. \"public\", \"private\")
NoteNotFoundError: The note being udpated does not exist
NoteDeletedError: Cannot update archived notes
ExceedMaxNoteCountError: A user can have maximum number of 25 notes
ExceedMaxWordCountError: A note cannot be more than 1000 characters long
GraphQL mutation for users to delete an existing profile note from their own profile
\nnoteId (String): The ID of the note to be deletedAccessForbiddenError: You do not have access to update this note
NoteNotFoundError: The note being udpated does not exist
NoteDeletedError: Cannot update archived notes
GraphQL query for users to fetch a specific profile note by ID from their own profile
\nnoteId (String): The ID of the noteNoteNotFoundError: The note being udpated does not exist
NoteDeletedError: Cannot update archived notes
GraphQL query for users to fetch all profile note on their own profile
\nGraphQL query for fetching your own user information within a given organizational unit
\norganizationalUnit (Object)
id (String): The ID of the organizational unit in context
type (String): Organization unit type (e.g. \"organization\", \"site\", \"department\")
id, firstName, lastName, role, workStatus, isDirectorySynced, joinDate, notes, address, etcGraphQL mutation to update your own profile information, such as their first name, last name, and job title
\ndetails(Object):
firstName(String)
lastName(String)
role(String): Job title of the user
This section contains functionalities applicable to your own user and profile.
\n","_postman_id":"92e19549-a9ad-4cce-b82a-c3162d8cd232","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_bearer}}"}]},"isInherited":true,"source":{"_postman_id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","name":"Private (Authenticated)","type":"folder"}}}],"id":"0c7116df-0dc1-4ce0-a3a3-624d407e0da2","description":"This section provides developers with essential details to seamlessly integrate user lookup and management functionalities into their applications. The documentation is divided into three sections: General, Admin, and Self queries.
\nThe General collection comprises queries accessible to all members, enabling access to information about others within their organization.
\nThe Admin collection offers queries that empower administrators to perform various user management tasks, including querying, creating, updating, and deleting user profiles. Additionally, administrators can reset user passwords, manage user addresses, logout user devices, and maintain user notes.
\nThe Self collection caters to users' needs to query and update their own profile information, as well as manage their addresses and notes.
\n","_postman_id":"0c7116df-0dc1-4ce0-a3a3-624d407e0da2","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_bearer}}"}]},"isInherited":true,"source":{"_postman_id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","name":"Private (Authenticated)","type":"folder"}}},{"name":"Chat","item":[{"name":"Admin","item":[{"name":"Remove Member","id":"c26cff43-fadf-4309-8607-9b4aa18bd8e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"hypercare-scope","value":"{{scopetoken}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation removeMember($chatId: ID!, $userId: ID!) {\n chat(chatId: $chatId) {\n admin {\n removeMember(userId: $userId) {\n ...ChatFragment\n }\n }\n }\n}\n\nfragment ChatFragment on Chat {\n id\n title\n members {\n ...GeneralUserFragment\n }\n lastMessage {\n ...MessageFragment\n }\n lastUnreadMessage {\n ...MessageFragment\n }\n unreadPriorityMessages\n}\n\nfragment GeneralUserFragment on GeneralUser {\n id\n username\n firstname\n lastname\n}\n\nfragment MessageFragment on Message {\n id\n type\n message\n sender {\n ...GeneralUserFragment\n }\n dateCreated\n}","variables":"{\n\t\"chatId\": \"{{chatId}}\",\n\t\"userId\": \"{{userId}}\"\n}"}},"url":"{{api_base_url}}/graphql/private","description":"GraphQL mutation for admins to remove a member from a chat. It verifies the membership, removes the member, and sends a system message to notify other members of the removal.
\nchatId (String): the ID of the chat from which the member is being removed.
userId (String): the ID of the user to be removed from the chat.
UserNotMemberOfChat : The user being removed is not a member of the chat
UserNotFound : Cannot find user for given ID
GraphQL mutation for admins to promote a member to become the admin of a chat.
\nchatId (String): the ID of the chat from which the member is being removed.
userId (String): the ID of the user to be removed from the chat.
UserNotMemberOfChat : The user being removed is not a member of the chat
UserNotFound : Cannot find user for given ID
This section contains functionalities only accessable to users with administrator privileges. The error UserNotAdminForScope will return for all unauthorized access.
Templated messages allows users to create structured and standardized fillable forms that ensure that the right types of information are sent. Examples of useful applications include consultation requests, verbal orders, and referral forms.
\nThe response to these templates are also customizable, allowing creators to specify the type of response that is expected, such as: require the recipient to formally acknowledge the message; require a specific decision/choice; or require a detailed free-text response.
\nThe following queries and mutations allows users to interact with existing templates.
\nPlease contact Hypercare's Customer Success team to learn more about setting up templated messages.
\n","_postman_id":"3cc44e98-8d23-432f-a73d-21deb9386f8d","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_bearer}}"}]},"isInherited":true,"source":{"_postman_id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","name":"Private (Authenticated)","type":"folder"}}},{"name":"Muting Chats","item":[{"name":"Mute Chat","id":"6ef30bbb-7bb4-4561-aabe-27f722b8dcc2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"hypercare-scope","value":"{{scopetoken}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation MuteChat($chatId: ID!, $muteTypes: [MuteNotificationType!]!) {\n chat(chatId: $chatId) {\n mute(types: $muteTypes)\n }\n}","variables":"{\n \"chatId\": \"{{chatId}}\",\n \"muteTypes\": [\n \"messages\",\n \"system\"\n ]\n}"}},"url":"{{api_base_url}}/graphql/private","description":"GraphQL mutation for muting notifications for a given chat.
\nchatId (String): The ID of the chat
muteTypes ([String]): An array of the type of messages to be muted (e.g. messages, system)
InvalidOperationShellAccount : Inactive/shell accounts cannot perform this actionGraphQL mutation for unmuting notifications for a given chat.
\nchatId (String): The ID of the chat
muteTypes ([String]): An array of the type of messages to be unmuted (e.g. messages, system)
InvalidOperationShellAccount : Inactive/shell accounts cannot perform this actionGraphQL query for checking if a chat has been muted
\nchatId (String): The ID of the chatUserNotMemberOfChat: You are not a part of the chat you are trying to access
ChatNotMemberOfOrganization: The chat ID given does not exist in your organization
InvalidOperationShellAccount : Inactive/shell accounts cannot perform this action
GraphQL query for retrieving the details of a specific chat. It verifies the user's membership in the chat and the chat's association with the user's organization before fetching the chat details.
\nchatId (String): ID of the chat to retrieveUserNotMemberOfChat: You are not a part of the chat you are trying to access
ChatNotMemberOfOrganization: The chat ID given does not exist in your organization
InvalidOperationShellAccount : Inactive/shell accounts cannot perform this action
This GraphQL query retrieves paginated messages for a given chat ID. It supports both forward and reverse pagination based on the provided direction.
\nchatId(String): ID referencing the chat to fetch messages for
continuationId (String, optional): ID of the message to start paginating from
limit(Int): the number of messages to load
direction(String): The direction of pagination. It can be either previous for forward pagination or next for reverse pagination
InvalidOperationShellAccount : Inactive/shell accounts cannot perform this actionGraphQL mutation for creating a new chat. It verifies the user's account status and then creates the chat with the specified members, type, and title. If chat matching similar pattern already exists then returns existing chat.
\nuserIds ([String]): An array of user IDs to be added as members of the chat
title (String, optional): The initial title of the chat
UserNotFound : One or more of the userIds being added to chat does not exist in the organization
InvalidOperationNonActiveAccount : One or more of the userIds to be added are inactive/shell accounts
ChatMembersExceedLimit : Exceed limit of 100 users per chat
InvalidOperationShellAccount : Inactive/shell accounts cannot perform this action
GraphQL mutation for adding new members to an existing chat. It verifies the user's membership in the chat and then adds the specified members to the chat.
\nchatId (String): The ID of the chat to which members are being added
userIds ([String]): An array of user IDs to be added as members of the chat
UserNotMemberOfChat : The user is not a member of the chat
ChatNotMemberOfOrganization: chatId provided does not corespond to any chat in the organization
ChatIsLocked: The chatId given belongs to a locked/archived chat
MemberAlreadyExistsError: One or more userIds being added already exists in the chat
InvalidUserIdError: One or more userIds provided are invalid or misformed (e.g., not in the correct format)
InvalidOperationShellAccount : Inactive/shell accounts cannot perform this action
GraphQL mutation for sending a message to a specific chat.
\nchatId (String): The ID of the chat to which the message is being sent
message (String): The content of the message to be sent
type (String, optional): The type of the message (text, image, system, attachment, template, consult)
priority (String, optional): The priority of the message (regular, urgent, stat)
fileId (String, optional): An id referencing the uploaded file on our S3 bucket (e.g. for file/picture messages). See 'Upload Files'
UserNotMemberOfChat : The user is not a member of the chat
ChatNotMemberOfOrganization: chatId provided does not corespond to any chat in the organization
ChatIsLocked: The chatId given belongs to a locked/archived chat
InvalidMessageType: The message type provided is invalid
InvalidMessagePriority: The message priority provided is invalid
InvalidOperationShellAccount : Inactive/shell accounts cannot perform this action
GraphQL mutation for replying to a specific message in chat.
\nchatId (String): The ID of the chat to which the message is being sent
message (String): The content of the message to be sent
repliedTo (Int): The message being replied to
type (String, optional): The type of the message (text, image, system, attachment, template, consult)
priority (String, optional): The priority of the message (regular, urgent, stat)
fileId (String, optional): An id referencing the uploaded file on our S3 bucket (e.g. for file/picture messages). See 'Upload Files'
UserNotMemberOfChat : The user is not a member of the chat
ChatNotMemberOfOrganization: chatId provided does not corespond to any chat in the organization
ChatIsLocked: The chatId given belongs to a locked/archived chat
InvalidMessageType: The message type provided is invalid
InvalidMessagePriority: The message priority provided is invalid
InvalidOperationShellAccount : Inactive/shell accounts cannot perform this action
GraphQL mutation for marking specific messages as read by the user in a particular chat.
\nchatId(String): The ID of the chat where the messages are being marked as read
messageIds ([String]): An array of message IDs to be marked as read
GraphQL mutation for marking specific messages as delivered to the user in a particular chat.
\nchatId(String): The ID of the chat where the messages are being marked as delivered
messageIds ([String]): An array of message IDs to be marked as delivered
GraphQL mutation for updating the name of a specific chat. It verifies the user's membership in the chat and updates the chat's title.
\nchatIds (String): The ID of the chat to be updated
title (String): The updated title of the chat
UserNotMemberOfChat : The user is not a member of the chat
ChatNotMemberOfOrganization: chatId provided does not corespond to any chat in the organization
InvalidOperationShellAccount : Inactive/shell accounts cannot perform this action
GraphQL mutation for allowing a user to leave a specific chat. It verifies the user's membership in the chat and then removes the user from the chat.
\nchatId(String): The ID of the chat that the user is leavingUserNotMemberOfChat : The user is not a member of the chat
ChatNotMemberOfOrganization: chatId provided does not corespond to any chat in the organization
ChatIsLocked: The chatId given belongs to a locked/archived chat
LastAdminOfChatError: Cannot remove the last admin of a chat before assigning a new admin
InvalidOperationShellAccount : Inactive/shell accounts cannot perform this action
This section contains functionalities accessable to all users with and without administrator privileges.
\n","_postman_id":"d3b1db73-9ee8-4afd-8f70-fb43bebd990e","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_bearer}}"}]},"isInherited":true,"source":{"_postman_id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","name":"Private (Authenticated)","type":"folder"}}}],"id":"ff01932c-99e6-449d-bb45-4e62f059af1c","description":"This section will provide developers with all the necessary information to integrate Hypercare's rich set of chat and messaging functionalities into their workflow using GraphQL. Our API supports a wide range of operations, from sending and receiving messages in real-time to managing chat groups and user presence.
\n","_postman_id":"ff01932c-99e6-449d-bb45-4e62f059af1c","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_bearer}}"}]},"isInherited":true,"source":{"_postman_id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","name":"Private (Authenticated)","type":"folder"}}},{"name":"Locating","item":[{"name":"Admin","item":[{"name":"Update Code Team Callback Number","id":"9020a671-6bc6-4bd9-a847-df8941543101","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"hypercare-scope","value":"{{scopetoken}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation UpdateCallbackNumber($teamId: Int!, $callbackNumber: String, $organizationalUnit: OrganizationalUnitInput!) {\n adminMutation {\n __typename\n ... on UserNotAdminForScope {\n __typename\n message\n }\n ... on AdminMutation {\n organizationalUnit(organizationalUnit: $organizationalUnit) {\n ... on OrganizationalUnitNotFoundError {\n __typename\n message\n }\n ... on AdminDepartmentMutation {\n __typename\n team(id: $teamId) {\n updateCallbackNumber(callbackNumber: $callbackNumber) {\n ... on Team {\n id\n name\n callbackNumber\n }\n }\n }\n }\n }\n }\n }\n}","variables":"{\n \"organizationalUnit\": {\n\t\t\"id\": {{departmentId}},\n\t\t\"type\": \"department\"\n\t},\n \"teamId\": {{codeTeamId}},\n \"callbackNumber\": \"12345\"\n}"}},"url":"https://{{api_hostname}}/v2/graphql/private","description":"GraphQL mutation that allows admins to update the callback number sent to numeric pagers when a code team is activated.
\norganizationalUnit (Object)
id (String): The ID of the department the code team belongs to
type (String): \"department\"
teamId (String): The ID of the code team to be updated
callbackNumber (String): The callback number to be displayed on numeric pagers in String format
OrganizationalUnitNotFoundError: The organization ID provided does not correspond to an existing organization
UserNotAdminForScope: User is not an admin of the organizational unit they are checking against
This section contains functionalities only accessable to users with administrator privileges. The error UserNotAdminForScope will return for all unauthorized access.
GraphQL query to fetch all code teams for a department
\ndepartmentId (Int): The ID of the departmentGraphQL mutation to activate a code teams with a specific message. Users and roles who are a part of team will be notified
\ncodeId (Int): The ID of the code team to be activated
message (String): Message sent to the alphanumeric pagers, and the Hypercare chat
This section contains functionalities accessable to all users with and without administrator privileges.
\n","_postman_id":"4454171a-ee78-49d3-812c-dc6ccbb7cf38","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_bearer}}"}]},"isInherited":true,"source":{"_postman_id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","name":"Private (Authenticated)","type":"folder"}}}],"id":"6a108ebb-3b4c-4869-bad8-0cc34939235f","description":"This section provides comprehensive information for integrating Hypercare's code activation features into your applications.
\nCode teams are specialized working units that can include both individual users and on-call roles. When a team is activated, all active users associated with the code are added to a group chat, and any pagers linked to shell accounts are contacted. The group chat will be named after the code team and include the timestamp of the activation.
\nTeams can be activated at either a STAT or regular notification level, depending on the preset urgency of the code. Activated codes support either individual or group escalations for active users through our messaging platform, ensuring timely and efficient communication.
\nFor setting up a code team, please reach out to our Customer Success team.
\n","_postman_id":"6a108ebb-3b4c-4869-bad8-0cc34939235f","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_bearer}}"}]},"isInherited":true,"source":{"_postman_id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","name":"Private (Authenticated)","type":"folder"}}},{"name":"Scheduling","item":[{"name":"Admin","item":[{"name":"Admin Fetch Schedule by Month","event":[{"listen":"test","script":{"id":"a4181fd5-ddac-4dc2-b825-9ea76b02a166","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{}}}],"id":"6cf7005a-71f5-41af-adbf-06cf8f7e455e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"hypercare-scope","value":"{{scopetoken}}","type":"text"},{"key":"hc-timezone","value":"{{hc-timezone}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query AdminFetchSchedule($siteId: Int!, $departmentId: Int!, $month: ScheduleMonths!, $year: Int!,$shiftStartDate: String!, $shiftEndDate: String!) {\n admin {\n organization {\n site(id: $siteId) {\n __typename\n department(id: $departmentId) {\n __typename\n schedule(month: $month, year: $year) {\n ...ScheduleFragment\n __typename\n }\n __typename\n }\n }\n __typename\n }\n __typename\n }\n}\n\nfragment ScheduleFragment on Schedule {\n id\n name\n startDate\n endDate\n state\n roles {\n ...RoleFragment\n __typename\n }\n createdAt\n updatedAt\n __typename\n}\n\nfragment RoleFragment on Role {\n id\n name\n auditId\n startTime\n endTime\n duration\n repeatRule\n pagerNumber\n required\n displayPosition\n currentShift {\n ...ShiftFragment\n __typename\n }\n nextShift {\n ...ShiftFragment\n __typename\n }\n shifts(startDate: $shiftStartDate, endDate: $shiftEndDate) {\n ...ShiftFragment\n __typename\n }\n createdAt\n updatedAt\n __typename\n}\n\nfragment ShiftFragment on Shift {\n id\n user {\n id\n username\n firstname\n lastname\n profilePic {\n url\n __typename\n }\n __typename\n }\n startDate\n endDate\n __typename\n}","variables":"{\n \"siteId\":{{siteId}},\n \"departmentId\":{{departmentId}},\"month\":\"june\",\n \"year\":2024,\n \"shiftStartDate\":\"2024-06-01T04:00:00.000Z\",\n \"shiftEndDate\":\"2024-07-01T04:59:59.000Z\"\n}"}},"url":"{{api_host_protocol}}{{api_hostname}}/graphql/private","description":"GraphQL query that allows admins to retrieve a single schedule for a specific department given its month and year. This can return schedule with either publish or draft status. A time range can also be passed in to fetch shifts associated with the schedule during those times.
\nsiteId (Int): ID of site
departmentId (Int): ID of department
month (String): Month of the schedule, lower case string. (e.g. \"january\", \"february\", \"march\", etc)
year (Int): Year of the schedule
shiftStartDate (Datetime, optional): Starting date time for shifts
shiftEndDate (Datetime, optional): Ending date time for shifts
GraphQL mutation that allows admins to create a schedule for given time range.
\ndepartmentId (Int): Department ID of where the schedule will be created
scheduleDetails (Object)
name (String): Name of the schedule
month (String): Month of the schedule, lower case string. (e.g. \"january\", \"february\", \"march\", etc)
year (Int): Year of the schedule
state (String, optional): Default draft (other options: published, archived)
shouldIncludeRoles (Boolean, optional): Default true, which will copy existing roles from the previous month's schedule onto this one
shouldIncludeShifts (Boolean, optional): Default false. If both shouldIncludeRoles and shouldIncludeShifts are set to true, function will duplicate both roles and shifts to new schedule
GraphQL mutation that allows admins to publish an existing draft schedule.
\ndepartmentId (Int): Department ID which the schedule belongs to
scheduleId (Int): ID of the schedule to be published
notifyOption (String): Default to affected, which changes made to the schedule after publishing will send emails notifying only users who's shifts were updated. (Other options: all: everyone on the schedule will be notified, none: no email notifications will be sent for future updates to the schedule)
note (String)
GraphQL mutation that allows admins to create a role for a given schedule.
\ndepartmentId (Int): Department ID of where the role will be created
roleDetails (Object)
name (String): Name of the schedule
startTime (String): Local starting of the role, in 24hr format
duration (Int): The default length of the role (in seconds)
repeatRule (String): The expected pattern of when the role should be filled (\"daily\", \"weekdays\", \"weekends\"). Default daily
offset (Int, optional): Offset from UTC time (in seconds). Default -240
required (Boolean, optional): Default false
scheduleId (Int): ID of the schedule where the role will be created in
GraphQL mutation that allows admins to update a role for a given schedule.
\ndepartmentId (Int): Department ID of where the role will be created
roleId (Int): ID of role being updated
updateDetails (Object)
name (String, optional): Name of the schedule
startTime (String, optional): Local starting of the role, in 24hr format
duration (Int, optional): The default length of the role (in seconds)
repeatRule (String, optional): The expected pattern of when the role should be filled (\"daily\", \"weekdays\", \"weekends\")
offset (Int, optional): Offset from UTC time (in seconds)
required (Boolean, optional): Requires shift to be filled for role
displayPosition (Int, optional): Display order of role in schedule
CantMutateArchivedRoleGraphQL mutation that allows admins to archive a role from a given schedule. NOTE: This will also archive all shifts and subsequent roles and shifts from the department.
\ndepartmentId (Int): Department ID of where the role will be created
roleId (Int): ID of role being updated
CantMutateArchivedRoleGraphQL mutation that allows admins to create a shift for a given role for a schedule.
\ndepartmentId (Int): Department ID of the schedule
scheduleId (Int): Schedule ID of the role
roleId (Int): Role ID for the shift
shiftDetails (Object)
userId (String): ID of user for shift
startTime (String): Start time of shift
endTime (String): End time of shift
GraphQL mutation that allows admins to update a shift.
\ndepartmentId (Int): Department ID of the schedule
scheduleId (Int): Schedule ID of the role
shiftId (Int): ID of shift to update
shiftDetails (Object)
userId (String, optional): ID of user for shift
startTime (String, optional): Start time of shift
endTime (String, optional): End time of shift
CantMutateArchivedShiftGraphQL mutation that allows admins to archive a shift.
\ndepartmentId (Int): Department ID of the schedule
scheduleId (Int): Schedule ID of the role
shiftId (Int): ID of shift to update
CantMutateArchivedShiftGraphQL mutation that allows admins to archive all the shifts for a given role.
\ndepartmentId (Int): Department ID of the schedule
roleId (Int): ID of role which the shifts will be removed from
CantMutateArchivedRole
CantMutateArchivedShift
This section contains functionalities only accessable to users with administrator privileges. The error UserNotAdminForScope will return for all unauthorized access.
GraphQL query that fetches ONE schedule within a given date range. If the start date is NULL then all schedules ending before the end date are returned. If the end date is NULL then all schedules starting after teh start date are returned. If both start and end date are NULL then all schedules are fetched.
\ndepartmentId (Int): ID of department
id (Int): ID of schedule
shiftStartDate (Datetime, optional): Starting date time for shifts
shiftEndDate (Datetime, optional): Ending date time for shifts
GraphQL query that fetches ONE schedule within a given date range. If the start date is NULL then all schedules ending before the end date are returned. If the end date is NULL then all schedules starting after teh start date are returned. If both start and end date are NULL then all schedules are fetched.
\norganizationalUnit (Object)
id (String): The ID of the department the schedule belongs to
type (String): \"department\"
id (Int): ID of schedule
shiftStartDate (Datetime, optional): Starting date time for shifts
shiftEndDate (Datetime, optional): Ending date time for shifts
GraphQL query that fetches a role given its ID.
\nroleId (Int): ID of roleGraphQL query that returns the schedule, roles, shifts between the given startDate and endDate time.
\ndepartmentId (Int): ID of department
startDate (Datetime, optional): Starting date time for schedule and shifts
endDate (Datetime, optional): Ending date time for schedule and shifts
GraphQL query that returns the schedule, roles, and on-call shifts for a given month and year. Month parameter should be styled as lower case full month name.
\n** To return on-call shifts, the current month & needs needs to be passed in.
\ndepartmentId (Int): ID of department
month (String): Month of the schedule, lower case string. (e.g. \"january\", \"february\", \"march\", etc)
year (Int): Year of the schedule
GraphQL query that returns the schedule information for all departments in a given site for the given month & year.
\nsiteId (Int): ID of site
month (String): Month of the schedule, lower case string. (e.g. \"january\", \"february\", \"march\", etc)
year (Int): Year of the schedule
GraphQL query that returns the schedule information for all departments in a given site for the given month & year.
\n** To return on-call shifts, the current month & needs needs to be passed in.
\nsiteId (Int): ID of site
month (String): Month of the schedule, lower case string. (e.g. \"january\", \"february\", \"march\", etc)
year (Int): Year of the schedule
GraphQL query that returns the basic schedule information and a downlaod link to an xlsx file for a department for the given month & year.
\ndepartmentId (Int): ID of site
month (String): Month of the schedule, lower case string. (e.g. \"january\", \"february\", \"march\", etc)
year (Int): Year of the schedule
This section contains functionalities accessable to all users with and without administrator privileges.
\n","_postman_id":"995b8a97-0b2b-4ae8-a8da-ac8b0baf2823","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_bearer}}"}]},"isInherited":true,"source":{"_postman_id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","name":"Private (Authenticated)","type":"folder"}}}],"id":"8dc6620a-fd76-4e54-aa95-24bfcffc0da7","description":"This section provides all the necessary information for integrating Hypercare's scheduling, role, and shift management features into your applications.
\nEach department within the organization can maintain one published schedule and one draft schedule at any given time. This structure allows departments to plan and review schedules before making them public.
\nClient queries are restricted to viewing only the published schedules, ensuring that draft schedules remain confidential and only accessible to authorized personnel. Admin queries, on the other hand, have the capability to view both published and draft schedules, allowing administrators to manage and finalize schedules effectively.
\nEach schedule includes roles that are identified by unique role IDs. These roles are linked to subsequent schedules through a role audit ID, ensuring consistency and traceability across different scheduling periods. When a role is updated, the changes are applied to all future roles linked by the same audit ID, maintaining uniformity across the schedule.
\nIf a role is deleted, all shifts assigned to that role will also be deleted. This ensures that the schedule remains accurate and that no orphaned shifts are left behind.
\n","_postman_id":"8dc6620a-fd76-4e54-aa95-24bfcffc0da7","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_bearer}}"}]},"isInherited":true,"source":{"_postman_id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","name":"Private (Authenticated)","type":"folder"}}},{"name":"Search","item":[{"name":"Search Chat by Name","id":"ed7fae66-ef1b-49f8-8734-2a00bd5debf9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"hypercare-scope","value":"{{scopetoken}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query search($text: String!, $continuationId: ID, $limit: Int, $direction: PaginationDirection) {\n searchQuery(text: $text) {\n searchChatTitles(continuationId: $continuationId, limit: $limit, direction: $direction) {\n continuationId\n totalResultsCount\n chats {\n chat {\n id\n title\n type\n image {\n id\n url\n }\n members {\n id\n username\n firstName\n lastName\n }\n }\n matchedSequences\n }\n }\n }\n}","variables":"{\n\t\"text\": \"test\"\n}\n"}},"url":"{{api_host_protocol}}{{api_hostname}}/v2/graphql/private/schema","description":"GraphQL query for retrieving a list of chats where their name match the inputted text. This will only return group chats with custom names (see search chat by members for chat member lookup).
\ntext (String): The search string. Minimum 2 characters, non-case-sensitive, and will filter out common stop words such as \"and\", \"the\", \"this\", etc. If multiple search words are passed in, each word, separated by space, is tokenized. Any symbols pre, or post-pending space separated tokens are sanitized.matchedSequences indicates which words from the input text were matched.EmptySearchQuery : Search text is either empty, or contains only non-valid wordsGraphQL query for retrieving a list of chats where the inputted text matches the name, or job title of some members who are a part of that chat. This will only return group chats and personal chats.
\ntext (String): The search string. Minimum 2 characters, non-case-sensitive, and will filter out common stop words such as \"and\", \"the\", \"this\", etc. If multiple search words are passed in, each word, separated by space, is tokenized. Any symbols pre, or post-pending space separated tokens are sanitized.matchedSequences indicates which words from the input text were matched.EmptySearchQuery : Search text is either empty, or contains only non-valid wordsGraphQL query for retrieving a list of chats where a certain search text appears in. (See Search Messages in Chat for lookup within a specific chat - recommended).
\ntext (String): The search string. Minimum 2 characters, non-case-sensitive, and will filter out common stop words such as \"and\", \"the\", \"this\", etc. If multiple search words are passed in, each word, separated by space, is tokenized. Any symbols pre, or post-pending space separated tokens are sanitized.matchedSequences indicates which words from the input text were matched.EmptySearchQuery : Search text is either empty, or contains only non-valid wordsGraphQL query for retrieving messages that match the search text within a given chat.
\ntext (String): The search string. Minimum 2 characters, non-case-sensitive, and will filter out common stop words such as \"and\", \"the\", \"this\", etc. If multiple search words are passed in, each word, separated by space, is tokenized. Any symbols pre, or post-pending space separated tokens are sanitized.
chatId (String): ID of the chat
matchedSequences indicates which words from the input text were matched.EmptySearchQuery : Search text is either empty, or contains only non-valid wordsGraphQL query for retrieving a paginated list of users for an organization. It supports filtering by member status, multiple organizational scopes, and search string, and it uses cursor-based pagination.
\norganizationalUnit (Object)
id (String): The ID of the organizational unit
type (String): Organization unit type (e.g. \"organization\", \"site\", \"department\")
filters (Object): An object containing the following optional filters
memberStatus([String], optional): The statuses of the users you wish to retreve (e.g. \"active\", \"inactive\", \"blocked\", \"archived\")
organizationaUnits ([String], optional): The scope which the users being retrived are in
searchQuery (String, optional): Search terms
pageInfo(Object): An object containing pagination information:
cursor(String, optional): The cursor for the current page
pageSize (Int, optional): The number of results per page
direction(String, optional): The direction of pagination (e.g., \"next\" or \"previous\")
OrganizationalUnitNotFoundError: The organization ID provided does not correspond to an existing organizationGraphQL query for retrieving an array of users who's name or job title matches the search text within a given scope.
\ntext (String): The search string. Minimum 2 characters, non-case-sensitive, and will filter out common stop words such as \"and\", \"the\", \"this\", etc. If multiple search words are passed in, each word, separated by space, is tokenized. Any symbols pre, or post-pending space separated tokens are sanitized.
filters (Object)
organizationalUnit (Object, optional)
id (String): The ID of the organizational unit in context
type (String): Organization unit type (e.g. \"organization\", \"site\", \"department\")
pageInfo(Object): An object containing pagination information:
cursor(String, optional): The cursor for the current page
pageSize (Int, optional): The number of results per page
direction(String, optional): The direction of pagination (e.g., \"next\" or \"previous\")
EmptySearchQuery : Search text is either empty, or contains only non-valid words
OrganizationalUnitNotFoundError: The organization ID provided does not correspond to an existing organization
GraphQL query for retrieving a paginated list of invites I've sent for an organization. It supports filtering by invite status and search query, and it uses cursor-based pagination.
\nfilters (Object): An object containing the following optional filters
searchQuery (String): Matching invited user's name, job title or emailpageInfo(Object): An object containing pagination information:
cursor(String, optional): The cursor for the current page
pageSize (Int, optional): The number of results per page
direction(String, optional): The direction of pagination (e.g., \"next\" or \"previous\")
REST POST endpoint for uploading files.
\n@return a list of ids referencing the uploaded files.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_bearer}}"}]},"isInherited":true,"source":{"_postman_id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","name":"Private (Authenticated)","type":"folder"}},"urlObject":{"protocol":"https","path":["upload_files"],"host":["{{api_hostname}}"],"query":[],"variable":[]}},"response":[{"id":"bf18174f-2f47-4f49-bfe3-94c9d14bb772","name":"Successful Upload","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"recovery-care-logo","type":"file","src":"/Users/umarazhar/Desktop/Screen Shot 2022-12-04 at 11.30.33.png"}]},"url":"{{api_host_protocol}}{{api_hostname}}/upload_files"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Surrogate-Control","value":"no-store"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, proxy-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=5184000; includeSubDomains"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"340"},{"key":"ETag","value":"W/\"154-2JbGUtbdanuhj6w1Xl7XnsglUA0\""},{"key":"Date","value":"Wed, 21 Dec 2022 13:19:32 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": [\n {\n \"id\": 150562,\n \"url\": \"https://hypercare-api-prod-images.s3.ca-central-1.amazonaws.com/15c412c0-1b04-11e7-b9b9-8f522ec4d570/c1bb6fd7-26b3-4a31-b778-7dfb5821a042.png\",\n \"fileName\": \"Screen Shot 2022-12-04 at 11.30.33.png\",\n \"mimeType\": \"image/png\",\n \"userId\": \"15c412c0-1b04-11e7-b9b9-8f522ec4d570\",\n \"createdAt\": \"2022-12-21T13:19:32.000Z\"\n }\n ]\n}"}],"_postman_id":"f7fb18d7-2f3b-4cdf-a4d5-73ca3d878e24"},{"name":"Fetch GraphQL Private Schema v1","id":"f10cf49b-abf8-4a18-80eb-840ceb257aaf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{api_hostname}}/graphql/schema/private","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_bearer}}"}]},"isInherited":true,"source":{"_postman_id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","name":"Private (Authenticated)","type":"folder"}},"urlObject":{"protocol":"https","path":["graphql","schema","private"],"host":["{{api_hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f10cf49b-abf8-4a18-80eb-840ceb257aaf"},{"name":"Fetch GraphQL Private Schema v2","id":"e2b14647-a635-4fe9-92a5-e5073d57bb3d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{api_host_protocol}}{{api_hostname}}/v2/graphql/private/schema","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_bearer}}"}]},"isInherited":true,"source":{"_postman_id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","name":"Private (Authenticated)","type":"folder"}},"urlObject":{"path":["v2","graphql","private","schema"],"host":["{{api_host_protocol}}{{api_hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e2b14647-a635-4fe9-92a5-e5073d57bb3d"}],"id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_bearer}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"6f35eecd-2dda-4515-b5d3-039e6dec0bad","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"6baf81dd-cc46-4fae-8141-a290867774a2","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"22c46175-6b87-4e76-9e1a-18f0c1bba491","description":""},{"name":"Health Check","id":"6640edf2-c667-4e0c-b5a9-5e86d789df55","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{api_hostname}}/health_check","urlObject":{"protocol":"https","path":["health_check"],"host":["{{api_hostname}}"],"query":[],"variable":[]}},"response":[{"id":"f2650be8-eb52-47ec-b5ad-81ef93be8f4c","name":"Success","originalRequest":{"method":"GET","header":[],"url":"https://{{api_hostname}}/health_check"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 05 Mar 2024 17:44:11 GMT"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Content-Length","value":"2"},{"key":"Connection","value":"keep-alive"},{"key":"X-Request-Id","value":"42f3e589-2721-4e27-a0b7-f813138796d0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Surrogate-Control","value":"no-store"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, proxy-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-XSS-Protection","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=5184000; includeSubDomains"},{"key":"ETag","value":"W/\"2-nOO9QiTIwXgNtWtBJezz8kv3SLc\""}],"cookie":[],"responseTime":null,"body":"OK"}],"_postman_id":"6640edf2-c667-4e0c-b5a9-5e86d789df55"}]}