Skip to main content

Users

This object represents a member of your business that has a Gigapipe account. It allows you to interact with users the way you would if you were using the Gigapipe UI. Actions such as obtaining your permission list or changing your password can easily be performed using the client or calling the API endpoint directly, provided that you have authorization for it.

Obtain the user info

Obtain the basic info of the user in session.

curl -X 'GET' \
'https://api.gigapipe.com/v1/users/me' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <your_access_token>'
# Payload response ::Dictionary
{
"first_name": "John",
"last_name": "Doe",
"organization": {
"name": "Lamborgini"
},
"verified": true,
"email": "john-doe@lamborgini.com"
}

The User Object

Attributes


first_name  ::String

The user first name


last_name  ::String

The user last name


email  ::String

The email the user signed up with


organization  ::Dictionary

The organization the user belongs to

name  ::String

The organization name


verified  ::Boolean

Whether the user has successfully gone through the verification process