Skip to main content
POST
/
v2
/
query
/
glasscore
/
user
Query User
curl --request POST \
  --url https://api.glass.fm/v2/query/glasscore/user \
  --header 'Content-Type: application/json' \
  --data '{
  "advancedFilter": {
    "linkOperator": "AND",
    "items": [
      {
        "columnField": "nameFirst",
        "operatorValue": "contains",
        "value": "John"
      }
    ]
  },
  "return": [
    "id",
    "firstName",
    "lastName"
  ],
  "isAdditionalData": false,
  "page": 1,
  "pageSize": 20,
  "sortBy": "createdAt",
  "sortDirection": "desc"
}'
{
  "email": "<string>",
  "id": 123,
  "isInvited": true,
  "isSuspended": true,
  "nameFirst": "<string>",
  "nameFirstLast": "<string>",
  "nameLast": "<string>",
  "PersonId": 123,
  "phone": "<string>",
  "RoleId": 123,
  "status": "<string>"
}

Body

application/json

Multiple query options are supported. You can build a complex query filling out the advancedFilter section. We also support "simple" queries which used by putting the key you want to filter by in the query section along with the value you want it to filter for. E.g., nameFirst=John will return all persons with a first name of John.

​
advancedFilter
object

Complex filter configuration allowing for multiple conditions with AND/OR operators.

​
return
string[]

Array of field names to return in the response.

Example:
["id", "firstName", "lastName"]
​
isAdditionalData
boolean
default:false

Set to true to merge requested fields with default response, or false/omit to return only requested fields plus ID.

​
page
number
default:1

Page number for pagination.

Example:

1

​
pageSize
number
default:500

Number of items per page. Defaults to 500.

Example:

20

​
sortBy
string

Field name to sort by.

Example:

"createdAt"

​
sortDirection
enum<string>
default:desc

Sort direction: ascending (asc) or descending (desc).

Available options:
asc,
desc
Example:

"desc"

​
{key}
string

Additional key-value pairs for simple filtering. Any field from the entity can be used as a filter key. E.g., field=value will return all records where that field matches the specified value.

Example:

"status=active"

Response

200 - application/json

A list of Users

​
email
string
required

The email address associated with the user's account.

​
id
number
required

Unique identifier for the user.

​
isInvited
boolean | null
required

Indicates whether the user has been invited but not yet registered.

​
isSuspended
boolean | null
required

Indicates whether the user's account is currently suspended.

​
nameFirst
string
required

The user's first name.

​
nameFirstLast
string
required

The user's full name in 'First Last' format.

​
nameLast
string
required

The user's last name.

​
PersonId
number | null
required

Identifier for the associated person record, nullable if not linked.

​
phone
string
required

The user's phone number.

​
RoleId
number
required

Identifier for the user's role or permission level.

​
status
string
required

Current status of the user's account (e.g., active, inactive, pending).