The Users API

With the users API new members can be invited to an organization or removed from an organization.

Requirements: You need an API access token with the users scope for this endpoint.

Invite Users

You can invite new users to an organization with API from the following endpoint:

POST /apps/api/organizations/{organization}/users/invite
Content-Type: application/json

{"emails": ["[email protected]", "[email protected]"]}

Users that are already invited or have accepted their invitation to the organization will be skipped. This endpoint can therefore be used to synchronize all currently active users from another system to Tideways.

Remove Users

You can remove users from an organization with API from the following endpoint:

DELETE /apps/api/organizations/{organization}/users to delete users from an organization
Content-Type: application/json

{"emails": ["[email protected]", "[email protected]"]}

Further reading

Authentication, Scopes, Rate Limiting

Still need help? Email [email protected]