List Members

POST

https://app.smartsuite.com/api/v1/members/list/

List Workspace Members (users). Responses are similar to List Records responses. Returned records do not include any fields with "empty" values, e.g. "", [], or false.

Example Request

curl -X POST https://app.smartsuite.com/api/v1/members/list/?offet=0&limit=3 \
  -H "Authorization: Token YOUR_API_KEY" \
  -H "ACCOUNT-ID: WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "sort": [],
  "filter": {}
}'

Query Parameters

Param	Type	Optional	Description
offset	number	Yes	For use in pagination - specify the offset value returned by the prior record response to retrieve the next page.
limit	number	Yes	Number of records to return per request. If not set, defaults to 100. Note: Value must be less than or equal to 1000. See the Pagination section below for more information.

Request Body

Param	Type	Optional	Description
sort	sort object	Yes	Object specifying sort parameters
filter	filter object	Yes	Object specifying filter parameters

Response Format

Param	Type	Description
items	array of objects	Array of member objects.
total	number	Total number of Members returned.
offset	number	Offset value for returned data.
limit	number	Limit value for returned data.
time	timestamp	ISO datetime of response.

200 - Example Response

{
    "items": [
        {
            "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": "2023-05-01T21:44:32.557000Z"
            },
            "deleted_date": {
                "date": null,
                "include_time": false
            },
            "ranking": {
                "default": "aagckvjtea"
            },
            "full_name": {
                "title": "",
                "first_name": "Peter",
                "middle_name": "",
                "last_name": "Novosel",
                "sys_root": "Peter Novosel"
            },
            "company_name": "SmartSuite",
            "department": "Executive Team",
            "about_me": "Peter is a Co-Founder and CTO of SmartSuite, overseeing product research, design and development efforts focused on delivering a single platform to manage all your work. With over 25 years of B2B and Enterprise software experience Peter brings to the team a passion for innovation and delivering amazing user experiences to customers of all sizes.",
            "job_title": "Co-Founder / CTO",
            "email": [
                "peter@smartsuite.com"
            ],
            "type": "1",
            "role": "1",
            "locale": "en-US",
            "timezone": "America/Chicago",
            "language": "en",
            "office_location": {
                "location_address": "15549 West 166th Street",
                "location_address2": "",
                "location_city": "Olathe",
                "location_state": "Kansas",
                "location_zip": "66062",
                "location_country": "United States",
                "location_longitude": "-94.80385869999999",
                "location_latitude": "38.826903",
                "sys_root": "15549 West 166th Street, Olathe, Kansas, 66062, United States"
            },
            "work_anniversary": {
                "date": "2019-03-04T00:00:00Z",
                "include_time": false
            },
            "certifications": [],
            "skills": [
                "63f7a91e2ffc5a4ceaf051c4",
                "63f7a91f2ffc5a4ceaf051c5",
                "63f7a9202ffc5a4ceaf051c6",
                "63f7a9212ffc5a4ceaf051c7"
            ],
            "hobbies": [
                "63f7a9222ffc5a4ceaf051c8",
                "645032bf4c3997e5288036ca"
            ],
            "linkedin": [
                "https://linkedin.com/in/peternovosel"
            ],
            "twitter": [
                "https://twitter.com/peternovosel"
            ],
            "facebook": [
                "https://www.facebook.com/pnovosel"
            ],
            "instagram": [
                ""
            ],
            "theme": "smartsuite_primary",
            "dob": {
                "date": "1970-11-01T00:00:00Z",
                "include_time": false
            },
            "profile_image": [
                {
                    "handle": "AMhkSKBSyiIBIj8ei0ll",
                    "metadata": {
                        "container": "smart-suite-media",
                        "filename": "1114_Peter-Novosel_106 (2).jpg",
                        "key": "Wju9hFnmRLeo99wCSS0n_1114_Peter-Novosel_106 (2).jpg",
                        "mimetype": "image/jpeg",
                        "size": 1171191
                    },
                    "transform_options": {
                        "crop": {
                            "dim": [
                                319,
                                288,
                                2302,
                                2302
                            ]
                        }
                    },
                    "file_type": "image",
                    "created_on": "2023-05-01T21:44:32.558000Z",
                    "updated_on": "2023-05-01T21:44:32.558000Z"
                }
            ],
            "cover_image": [],
            "cover_template": "245",
            "biography": [],
            "phone": [
                {
                    "phone_country": "US",
                    "phone_number": "+1 913 553 7700",
                    "phone_extension": "",
                    "phone_type": 2,
                    "sys_root": "19135537700",
                    "sys_title": "+1 913 553 7700"
                }
            ],
            "teams": [
                "63a1f65b23aaf6bcb564b1fd",
                "63d1a954195ca92df675e5c9"
            ],
            "ip_address": [
                {
                    "address": "136.37.148.189",
                    "country_code": "us"
                }
            ],
            "last_login": {
                "date": "2023-05-30T22:47:38.837000Z",
                "include_time": true,
                "_cls": "DateDocument"
            },
            "id": "63a1f65723aaf6bcb564b1f1",
            "application_slug": "members",
            "deleted_date": {
                "date": null
            },
            "status": {
                "value": "1",
                "updated_on": "2022-12-20T17:52:24.804000Z"
            }
        }
    ],
    "total": 1,
    "offset": 0,
    "limit": 0,
    "time": "2023-05-30T23:08:27.324200Z"
}