List organization members
Organization Members are external contacts associated with organizations (customers, partners, suppliers, etc.). They represent people you work with outside your company.
This endpoint returns a paginated, filterable, and sortable list of all organization members in your workspace.
What you can do:
- Filter members by organization, status, position, or role
- Search by name or email
- Sort by any column
- Select specific fields to return
Returns: A grid response with organization member data including name, position, email, active status, login capability, and avatar information.
Retrieves a paginated grid of organization members with filtering and sorting capabilities. Quick search available on: firstName, lastName, email. Filterable fields: id, organizationId, firstName, lastName, email, position, isActive, canLogin, gender, phone, addressCity, addressCountry, roleId, userId, avatarId, createdAt, editedAt. Sortable fields: id, organizationId, firstName, lastName, email, position, isActive, canLogin, gender, addressCity, addressCountry, roleId, userId, createdAt, editedAt.
/organizations/membersAuthorizationOAuth2 access token · headerrequiredapi:readAuthorizationBearer token (JWT) · headerrequiredpagenumberPage number (1-based)
pageSizenumberNumber of items per page
viewIdstringView identifier for saved grid configurations
quickSearchstringQuick search text. Searches across: firstName, lastName, email
filtersstringJSON string containing filter configuration.
Available Fields:
- id (string): Organization member ID
- organizationId (string): Organization ID
- firstName (string): First name
- lastName (string): Last name
- email (string): Email address
- position (string): Position/title in organization
- isActive (boolean): Whether member is active
- canLogin (boolean): Whether member can login (derived from user status)
- gender (set): Gender
- phone (string): Phone number
- addressCity (string): City
- addressCountry (string): Country
- roleId (string): User role ID
- userId (string): Associated user ID
- avatarId (string): Avatar file ID
- createdAt (date): Creation timestamp
- editedAt (date): Last update timestamp
Filter Structure:
[
{
"type": "string|number|date|set|boolean|array|task_status|task_type",
"fieldName": "field_name",
"value": {
"comparison": "comparison_type",
"value": "filter_value"
}
}
]
Group Filters (AND/OR Combinations):
[
{
"type": "group",
"fieldName": "group0.18807479823070028",
"value": {
"type": "or",
"filters": [
{
"type": "string",
"fieldName": "fileName",
"value": {
"comparison": "contain",
"value": "aa"
}
},
{
"type": "number",
"fieldName": "rowCount",
"value": {
"comparison": ">=",
"value": 33
}
}
]
}
}
]
Available Comparison Operators:
- id (string): Organization member ID (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty
- organizationId (string): Organization ID (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty
- firstName (string): First name (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty
- lastName (string): Last name (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty
- email (string): Email address (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty
- position (string): Position/title in organization (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty
- isActive (boolean): Whether member is active (boolean filter). Available comparisons: equal, not_equal
- canLogin (boolean): Whether member can login (derived from user status) (boolean filter). Available comparisons: equal, not_equal
- gender (set): Gender (set filter). Available comparisons: in, not_in, is_empty, is_not_empty
- phone (string): Phone number (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty
- addressCity (string): City (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty
- addressCountry (string): Country (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty
- roleId (string): User role ID (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty
- userId (string): Associated user ID (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty
- avatarId (string): Avatar file ID (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty
- createdAt (date): Creation timestamp (date filter). Available comparisons: equal, not_equal, >, <, >=, <=, between, lastMonth, thisMonth, is_empty, is_not_empty
- editedAt (date): Last update timestamp (date filter). Available comparisons: equal, not_equal, >, <, >=, <=, between, lastMonth, thisMonth, is_empty, is_not_empty
Note: Use quickSearch parameter for simple text search instead of adding it to filters.
sortstringJSON array of sort objects.
Sortable Fields:
- id: Organization member ID
- organizationId: Organization ID
- firstName: First name
- lastName: Last name
- email: Email address
- position: Position/title in organization
- isActive: Whether member is active
- canLogin: Whether member can login (derived from user status)
- gender: Gender
- addressCity: City
- addressCountry: Country
- roleId: User role ID
- userId: Associated user ID
- createdAt: Creation timestamp
- editedAt: Last update timestamp
Sort Structure:
[
{
"field": "field_name",
"direction": "asc|desc"
}
]
Default Sort: lastName (asc)
fieldsToReturnstring[]Comma-separated list of field names to include in response items. If not provided, all fields are returned.
Available Fields: id, organizationId, firstName, lastName, email, position, isActive, canLogin, gender, phone, addressCity, addressCountry, roleId, userId, avatarId, createdAt, editedAt
Paginated list of organization members
Unauthorized - Invalid or missing authentication token
Forbidden - Insufficient API scopes or permissions