Shared Users

Retrieve team members (shared users)

GETaccount/sharedUsers

Retrieves a list of all the team members that have access to a given project. It also returns the state of each member. The state can be: 'owner' (they are the project owner), 'active' (they are a shared user) or 'pending' (they have been invited but haven't finished signing up to GoSquared).

Note: Only API keys generated by the project owner have permission to be used with this endpoint.

Run in PostmanPostman is a useful developer tool for experimenting with and managing APIs that you work with

Definition

GET https://api.gosquared.com/account/v1/sharedUsers

Example Request

curl "https://api.gosquared.com/account/v1/sharedUsers?api_key=demo&site_token=GSN-106863-S" 

Live Responseundefined undefined

Your API Key is not authorised for this endpoint

Please fill in the required fields in the Query Builder

Add a team member

POSTaccount/sharedUsers

Adds a user to the list of shared users based on their email address. If the given email address is not associated with a GoSquared account then they will be invited to create an account and gain access to the shared project.

Note: Only API keys generated by the project owner have permission to be used with this endpoint.

POST Body

email

StringRequired

A valid email address

notify

BooleanDefault Value: true

Whether to send an invite/notification email to the invitee or not.

Run in PostmanPostman is a useful developer tool for experimenting with and managing APIs that you work with

Definition

POST https://api.gosquared.com/account/v1/sharedUsers

Example Request

curl -X POST -H "Content-Type: application/json" \
  "https://api.gosquared.com/account/v1/sharedUsers?api_key=demo&site_token=GSN-106863-S" 

Live Responseundefined undefined

Your API Key is not authorised for this endpoint

Remove a team member

DELaccount/sharedUsers

Remove a user from a specific project so that they no longer have to access it.

Note: Only API keys generated by the project owner have permission to be used with this endpoint.

Query String Parameters

email

StringRequired

A valid email address

Run in PostmanPostman is a useful developer tool for experimenting with and managing APIs that you work with

Definition

DEL https://api.gosquared.com/account/v1/sharedUsers

Example Request

curl -X DEL -H "Content-Type: application/json" \
  "https://api.gosquared.com/account/v1/sharedUsers?api_key=demo&site_token=GSN-106863-S" 

Live Responseundefined undefined

Your API Key is not authorised for this endpoint