Users | Hitchhikers Platform

Overview

The Users endpoints allow you to manage Yext users within a Yext account and their access controls via the Account Settings API. This includes: creating a new user, updating a user’s information, updating a user’s password, or deleting a user.

You can also use the Users: List endpoint to retrieve a list of users within the account, or Users: Get to retrieve details of a specific user.

In addition to managing individual users, if your account is leveraging the Content Approvals feature, you can also use the ApprovalGroups endpoints to manage your Approval Groups. This includes: creating an Approval Group, updating an Approval Group, or deleting an Approval Group.

You can also use the ApprovalGroups: List endpoint to retrieve a list of all Approval Groups within the account, or ApprovalGroups: Get to retrieve details of a specific Approval Group.

Use Cases

Set up an integration that creates or updates your users in Yext
Manage user access controls
Manage user approval groups

Reference Docs

Guides

Manage Users