List Users - StateSet API Docs

Body

limit

string

required

This is the limit of the users.

offset

string

required

This is the offset of the users.

order_direction

string

required

This is the order direction of the users.

Response

number

This is the id of the user.

active

boolean

This is the active of the user.

avatar

string

This is the avatar of the user.

bio

string

This is the bio of the user.

birthday

string

This is the birthday of the user.

country

string

This is the country of the user.

string

This is the email of the user.

firstName

string

This is the firstName of the user.

lastName

string

This is the lastName of the user.

last_seen

string

This is the last_seen of the user.

last_typed

string

This is the last_typed of the user.

location

string

This is the location of the user.

organization

string

This is the organization of the user.

phone

string

This is the phone of the user.

regions

string

This is the regions of the user.

title

string

This is the title of the user.

twitter

string

This is the twitter of the user.

username

string

This is the username of the user.

curl --location --request GET 'https://api.stateset.com/v1/users/:id' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
    "limit": 10,
    "offset": 0,
    "order_direction": "asc"
}'

{
  "id": 1,
  "active": true,
  "avatar": "",
  "bio": "This is the bio of the user.",
  "birthday": "2020-01-01",
  "country": "US",
  "email": "[email protected]",
}

Users

Name	Type	Description
id	Text (Primary Key, Unique)	Unique identifier for the user
active	Boolean	Indicates if the user is currently active
avatar	Text	URL or path to the user’s avatar image
bio	Text	Biography or description of the user
birthday	Date	Date of birth of the user
country	Text	Country of residence of the user
email	Text	Email address of the user
firstName	Text	First name of the user
lastName	Text	Last name of the user
last_seen	Date/Time	Date and time when the user was last seen
last_typed	Date/Time	Date and time when the user last typed a message
location	Text	Location or address of the user
organization	Text	Organization or company the user belongs to
phone	Text	Phone number of the user
regions	Text	Regions or areas associated with the user
title	Text	Title or job position of the user
twitter	Text	Twitter handle or username of the user
username	Text	Unique username of the user

StateSet Response

​Body

​Response

​Users

Body

Response

Users