Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Managing teams and members

A simple guide to use APIs to manage teams and members of your account

Usually, when managing teams and members, APIs are not involved: one would use the UI in order to perform such tasks. However, in big organisations, and when no enterprise integrations are used, this may be required.

In order to use APIs to manage teams and members you will need an authorization token which is associated to an account administrator. You can do so from dashboard in the tokens section:

The dashboard - tokens section

Once you have the token, you can simply use it in your calls, here there are few examples using "curl" assuming your token is in the environment variable METERIAN_API_TOKEN.

Managing members

To manage account members you will need to first get your account UUID as well. You can obtain it with this call:

The UUID of your account in this case d80d5f9c-a3b2-4ecb-9ce6-9891d4929bda, let's put into another variable called ACCOUNT_UUID just for simplicity. Let's have a look to some examples of usage.

Adding a member to the account

To add a new member into the account just use the POST verb, passing the required data:

Listing account members

You can list account members to see that the member was added:

Removing account members

To remove a member just use the DELETE verb on the resource, specifying the member email:

Managing teams

If you have an enteprise account, or yu have the Teams feature enabled in your account, you can also manage teams. To create a team, you can execute a simple POST call using the REST APis:

You will receive a 200 return code, and you will be able to see the new team, also via API, just asking for the list:

As you can see there's the default team "EVERYONE" and the newly created team. For semplicity, let's put the UUID of the team in the environment variable TEAM_UUID, we will need it in the next exaples.

If you made a mistake, you can delete the team using the UUID returned in the field of the object:

Once a team is created, you can then add and remove members from such team

Adding a member to a team (and to the account)

You can use this style of call when you want to add a member that is not present in the account. This call will add the member to the EVERYONE team and to this specific team. It's advantageous as you won't need to do multiple calls. Let's imagine we want to add Alan, a viewer in the account (see the "membership" section of the data) and a collaborator in the team:

Listing team members

Removing a member from a team

You can remove a member from a team as well (while leaving him in the account) using the member UUID and a DELETE call to the REST API:

Adding a member to a team (when the member is already in the account)

To add a member to a team when such member is already in the account is really easy if you now its UUID in the account. If not, you can get it with an API call:

Then you can simply add the REST call to add a member to a team, specifying the UUID:

A simple tool: importing contacts from a CSV file

A simple Python script is available on GitHub as an easy to use tool to import contacts from a CSV file. It uses the APIs described in this guide, and can be used as it is, or as a staring point for your automation endeavours!

Just create a CSV file whith the required fields (full name, email address, role within the team, team name) and run the tool to import those users in your account.

You can access the script on GitHub.

What next?

Please be aware that all APIs are available via Swagger:

Any further question please drop a line to your support line!

PreviousGuidesNextGenerating reports via APIs

Last updated