Member Object
Object Literals
| Param | Type | Nullable | Description |
|---|---|---|---|
| application_id | string | No | Id of Members application |
| availability_status | availability status object | No | Member's availability status |
| comments_count | number | No | Total comments made by the Member |
| first_created | first created object | No | Date and Member who created the Member record. by is a Member Id; with hydrated=true, an expanded member object (id, full_name, email) instead. |
| last_updated | last updated object | No | Date and Member who last updated the Member record. by is a Member Id; with hydrated=true, an expanded member object (id, full_name, email) instead. |
| ranking | ranking object | No | |
| id | string | No | Member's record id |
| application_slug | string | No | Always set to members |
| deleted_date | date object | Yes | Date Member was deleted |
| full_name | full name object | No | Name of the Member |
| company_name | string | No | Member's company name |
| department | string | No | Member's department name |
| about_me | string | No | Member's about text |
| job_title | string | No | Member's job title |
array of strings | No | Member's email address | |
| type | string | No | Member's user type, as a numeric string
|
| role | string | No | Member's role type, as a numeric string
|
| locale | string | No | Member's locale |
| timezone | string | No | Member's time zone |
| language | string | No | Member's language (2 character abbreviation) |
| office_location | office location object | No | Member's office location |
| work_anniversary | date object | No | Member's work anniversary |
| certifications | array of strings | No | Member's professional certifications |
| skills | array of strings | No | Member's skills |
| hobbies | array of strings | No | Member's hobbies |
array of strings | No | Member's linkedin | |
array of strings | No | Member's twitter | |
array of strings | No | Member's facebook | |
array of strings | No | Member's instagram | |
| theme | string | No | Member's selected theme |
| dob | date object | No | Member's date of birth |
| profile_image | array of file objects | No | Member's profile image |
| cover_image | array of file objects | No | Member's cover image |
| cover_template | string | No | Member's cover template id (as string) |
| biography | array of file objects | No | Member's biography document |
| phone | array of phone objects | No | Member's phone number |
| teams | array of strings | No | Ids of Member's Teams |
| ip_address | array of ip address field objects | No | Member's IP address |
| last_login | last login object | No | Date and time Member last logged in |
| status | member status object | No | Member status |
For the paginated list response that wraps member objects, see List Members.
Example
{
"application_id": "63a1f65723aaf6bcb564b1f0",
"availability_status": {
"emoji": "",
"status": "",
"selected_interval": "",
"clear_after": {
"date": null,
"include_time": false
}
},
"comments_count": 0,
"first_created": {
"on": "2022-12-20T17:52:23.867000Z",
"by": "63a1f65723aaf6bcb564b1f1"
},
"last_updated": {
"by": "63a1f65723aaf6bcb564b1f1",
"on": "2024-06-06T18:58:58.862000Z"
},
"ranking": {
"default": "aagckvjtea"
},
"id": "63a1f65723aaf6bcb564b1f1",
"application_slug": "members",
"deleted_date": {
"date": null
},
"full_name": {
"title": "",
"first_name": "Jane",
"middle_name": "",
"last_name": "Doe",
"sys_root": "Jane Doe"
},
"company_name": "Example Company",
"department": "Engineering",
"about_me": "Jane leads the engineering team.",
"job_title": "Engineering Manager",
"email": [
"jane.doe@example.com"
],
"status": {
"value": "1",
"updated_on": "2022-12-20T17:52:24.804000Z"
},
"type": "1",
"role": "1",
"locale": "en-US",
"timezone": "America/Chicago",
"language": "en",
"office_location": {
"location_address": "123 Main Street",
"location_address2": "",
"location_city": "Springfield",
"location_state": "Illinois",
"location_zip": "62701",
"location_country": "United States",
"location_longitude": "-89.6501",
"location_latitude": "39.7817",
"sys_root": ""
},
"work_anniversary": {
"date": "2019-03-04T00:00:00Z",
"include_time": false
},
"certifications": [],
"skills": [
"63f7a91e2ffc5a4ceaf051c4",
"63f7a91f2ffc5a4ceaf051c5",
"63f7a9202ffc5a4ceaf051c6",
"63f7a9212ffc5a4ceaf051c7"
],
"hobbies": [
"63f7a9222ffc5a4ceaf051c8",
"666206f268af3ed2602380ef"
],
"linkedin": [
"https://linkedin.com/in/janedoe"
],
"twitter": [
"https://twitter.com/janedoe"
],
"facebook": [
"https://www.facebook.com/janedoe"
],
"instagram": [
""
],
"theme": "smartsuite_primary",
"dob": {
"date": "1990-01-01T00:00:00Z",
"include_time": false
},
"profile_image": [
{
"handle": "aBcDeFgHiJkLmNoPqRsT",
"metadata": {
"container": "smart-suite-media",
"filename": "profile.jpg",
"key": "aBcDeFgHiJkLmNoPqRsT_profile.jpg",
"mimetype": "image/jpeg",
"size": 204800
},
"transform_options": {
"crop": {
"dim": [
332,
161,
2302,
2302
]
}
},
"file_type": "image",
"created_on": "2024-06-06T18:58:59.037000Z",
"updated_on": "2024-06-06T18:58:59.037000Z"
}
],
"cover_image": [],
"cover_template": "245",
"biography": [],
"phone": [
{
"phone_country": "US",
"phone_number": "+1 555 010 0100",
"phone_extension": "",
"phone_type": 2,
"sys_root": "15550100100",
"sys_title": "+1 555 010 0100"
}
],
"teams": [
"63a1f65b23aaf6bcb564b1fd",
"63d1a954195ca92df675e5c9",
"64bad7fcab28cca9fcc0ea01",
"65ce93e5e6bd79eeaf37045d"
],
"ip_address": [
{
"address": "203.0.113.10",
"country_code": "US"
}
],
"last_login": {
"date": "2024-06-11T19:52:31.386000Z",
"include_time": true
}
}