API Reference
This topic provides a list of all the user and account management APIs with links to related API reference documentation.
Account or company
| API | Description | REST | GraphQL |
|---|---|---|---|
| Create an account | Creates a new marketplace account (company). | Create a company | Create an account |
| Update an account | Updates a marketplace account (company). | Update a company | Update an account |
| Patch an account | Partially updates a marketplace account (company). | Patch a company | Patch an account |
| Read an account | Retrieves an account (company) by ID. | Read a company | Read an account |
| Read all accounts | Retrieves a list of accounts (companies). | Read all companies | Read all accounts |
| Read account activities | Retrieves company or user activities. | Read company or user activities | NA |
Users
| API | Description | REST | GraphQL |
|---|---|---|---|
| Update a user | Updates a marketplace user. | Update a user | Update a user |
| Patch a user | Partially updates a marketplace user. | Patch a user | Patch a user |
| Update a user profile | Updates a marketplace user's profile. | Update a user profile | NA |
| Patch a user profile | Partially updates a marketplace user's profile. | Patch a user profile | NA |
| Activate a user | Activates a marketplace user using its associated activation token. | Activate a user | NA |
| Read a user | Retrieves a marketplace user by ID or external ID. | Read a user | Read a user |
| Read a user profile | Retrieves profile information for a marketplace user. | Read a user profile | NA |
| Read a user memberships | Retrieves a user's account (company) memberships. | Read a user memberships | NA |
| List all users | Retrieves all marketplace users. | List all users | List all users |
User and account memebership
| API | Description | REST | GraphQL |
|---|---|---|---|
| Create company membership | Retrieves all marketplace users. Adds a new or existing user as a member of a marketplace account (company). | Create company membership | Create account membership |
| Update company membership | Updates a marketplace user's account (company) membership. | Update company membership | NA |
| Delete company membership | Deletes a marketplace user's account (company) membership. | Delete company membership | Delete account membership |
| Enable or Disable company membership | Enables or disables marketplace user's company membership. | Enable or Disable company membership | Enable account membership Disable account membership |
| Read company membership | Retrieves an account membership by account ID and user ID. | Read company membership | Read account membership |
| List company memberships | Lists a marketplace company's user memberships. | List company memberships | List account memberships |
Was this page helpful?
Tell us more…
Help us improve our content. Responses are anonymous.
Thanks
We appreciate your feedback!