Members

This section provides details on the member model used to represent users associated with an account. Below are the properties that define a member.

The member model

The member model represents various attributes associated with a member, including identification details, contact information, and role.

Properties

Name
id
Type
string
Description
Unique identifier for the member.
Name
name
Type
string
Description
The name of the member.
Name
email
Type
string
Description
The email of the member.
Name
username
Type
string
Description
The username of the member.
Name
role
Type
string
Description
The role of the member, this can be an Owner, Admin or a Viewer.
Name
disabled_at
Type
timestamp | null
Description
Timestamp if the member is disabled.
Name
last_login_at
Type
timestamp | null
Description
Timestamp of the member's last login.
Name
created_at
Type
timestamp
Description
Date of which the member is created.
Name
updated_at
Type
timestamp
Description
Date of which the member is updated_at.

GET/v1/members

List all members

This endpoint allows you to retrieve a paginated list of all your members. By default, a maximum of 50 members are shown per page.

Optional attributes

Name
per_page
Type
integer
Description
Limit the number of members returned.
Name
page
Type
integer
Description
The current page number of members
Name
filter[account_id]
Type
string
Description
Filter the members by account_id

Request

GET

/v1/members

curl -G https://api.polaris.revlv.com/v1/members \
-H "Authorization: Bearer {token}" \
-H "Polaris-Account: {account_id}" \
-d per_page=50

Response

{
  "data": [
	{
		"id": "9c3c6ce1-9365-494c-b830-dd034851431c",
		"name": "John Doe",
		"email": "johndoe@mail.com",
		"username": "johndoe",
		"role": "Owner",
		"disabled_at": null,
		"last_login_at": "2024-06-08T08:07:50+00:00",
		"created_at": "2024-06-08T07:56:26+08:00",
		"updated_at": "2024-06-08T07:56:26+08:00"
	},
    {
      "id": "97c50f61-3754-3a9c-a16d-c580677d5fed"
      // ...
    }
  ]
}