Skip to main content
POST
/
v2
/
query
/
glasscore
/
person
Query Person
curl --request POST \
  --url https://api.glass.fm/v2/query/glasscore/person \
  --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"
}'
{
  "c_org": "<string>",
  "city": "<string>",
  "dateOfBirth": "<string>",
  "email": "<string>",
  "id": 123,
  "isApplicant": true,
  "isStaff": true,
  "nameFirst": "<string>",
  "nameFirstLast": "<string>",
  "nameLast": "<string>",
  "OrgId": 123,
  "phone": "<string>",
  "RandomPoolStatusId": 123,
  "state": "<string>",
  "streetPrimary": "<string>",
  "streetSecondary": "<string>",
  "UserId": 123,
  "zip": "<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 Persons

​
c_org
string
required

Represents the organization that the individual in the Person table is associated with.

​
city
string
required

Represents the urban area or municipality where the individual resides.

​
dateOfBirth
required

Records the day, month, and year when the individual was born.

​
email
string
required

Stores the electronic mail address of the individual.

​
id
number
required

Unique identifier.

​
isApplicant
boolean
required

Indicates whether the individual is a candidate for a position or role.

​
isStaff
boolean
required

Indicates whether the person is a staff member or not.

​
nameFirst
string
required

Contains the first name of the individual in the Person table.

​
nameFirstLast
string
required

Stores the full name of an individual in the format of first name followed by last name.

​
nameLast
string
required

Stores the surname of the individual.

​
OrgId
number
required

Represents the unique identifier for the organization to which the individual belongs.

​
phone
string
required

Stores the contact number of the individual.

​
RandomPoolStatusId
number | null
required

Indicates the status of a person's association with a random pool in a system, typically represented by a unique identifier.

​
state
string
required

Indicates the U.S. state or territory where the individual resides.

​
streetPrimary
string
required

Contains the main street address for an individual.

​
streetSecondary
string
required

Contains additional information about the person's street address such as apartment or suite number.

​
UserId
number | null
required

A unique identifier assigned to each individual in the Person table.

​
zip
string
required

Stores the postal code associated with each individual's residential address.