List organizations
Returns a paginated, filterable, and sortable grid of all organizations in the workspace.
What are Organizations? Organizations represent external business partners that your company has contact with:
- Customers: Existing business partners with ongoing projects
- Prospects: Potential customers with first contact or active offers
- Suppliers: External providers of goods or services
- Partners: Strategic partners or resellers
- Competitors: Competitors in the same industry
- Service Providers: Supporting external providers (e.g., for support)
- Investors: Financial or institutional investors
- Authorities: Public institutions or government agencies
- Educational Institutions: Universities, schools, or research institutes
- Target Groups: Companies that belong to your target customer group
Organizations are the foundation for managing external projects, contacts (organization members), invoices, and business relationships. They allow you to structure and analyze all external partnerships in one place.
What is returned:
- Organization identification (ID, name, short name, type, color, icon)
- Status information (active/inactive)
- Relationship data (number of linked projects, number of members/contacts)
- Creation and update timestamps
- Logo information
Filtering and search:
- Quick search across organization name, short name, and other fields
- Advanced filtering by type, status, and other attributes
- Sorting by any sortable field
- Server-side pagination for large organization lists
Note: This endpoint requires the Organizations.view permission. Retrieves a paginated grid of organizations with filtering and sorting capabilities. Quick search available on: name, shortName. Filterable fields: id, name, shortName, type, isActive, email, phoneNumber, website, addressCity, addressCountry, addressStreet, addressZip, startOfCollaboration, createdAt, editedAt, isFavorite, parentOrganizationId, parentOrganizationName. Sortable fields: id, name, shortName, type, isActive, addressCity, addressCountry, startOfCollaboration, createdAt, editedAt, isFavorite, parentOrganizationId.
/organizationsAuthorizationOAuth2 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: name, shortName
filtersstringJSON string containing filter configuration.
Available Fields:
- id (string): Organization ID
- name (string): Organization name
- shortName (string): Short identifier
- type (set): Organization type (Customer, Vendor, Partner, etc.)
- isActive (boolean): Whether organization is active
- email (string): Email address
- phoneNumber (string): Phone number
- website (string): Website URL
- addressCity (string): City
- addressCountry (string): Country
- addressStreet (string): Street address
- addressZip (string): ZIP/Postal code
- startOfCollaboration (date): Start of collaboration date
- createdAt (date): Creation timestamp
- editedAt (date): Last update timestamp
- isFavorite (boolean): Whether the organization is marked as favorite by the current user
- parentOrganizationId (string): Parent organization ID
- parentOrganizationName (string): Parent organization name
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 ID (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty
- name (string): Organization name (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty
- shortName (string): Short identifier (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty
- type (set): Organization type (Customer, Vendor, Partner, etc.) (set filter). Available comparisons: in, not_in, is_empty, is_not_empty
- isActive (boolean): Whether organization is active (boolean filter). Available comparisons: equal, not_equal
- email (string): Email address (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty
- phoneNumber (string): Phone number (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty
- website (string): Website URL (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
- addressStreet (string): Street address (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty
- addressZip (string): ZIP/Postal code (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty
- startOfCollaboration (date): Start of collaboration date (date filter). Available comparisons: equal, not_equal, >, <, >=, <=, between, lastMonth, thisMonth, 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
- isFavorite (boolean): Whether the organization is marked as favorite by the current user (boolean filter). Available comparisons: equal, not_equal
- parentOrganizationId (string): Parent organization ID (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty
- parentOrganizationName (string): Parent organization name (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, 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 ID
- name: Organization name
- shortName: Short identifier
- type: Organization type (Customer, Vendor, Partner, etc.)
- isActive: Whether organization is active
- addressCity: City
- addressCountry: Country
- startOfCollaboration: Start of collaboration date
- createdAt: Creation timestamp
- editedAt: Last update timestamp
- isFavorite: Whether the organization is marked as favorite by the current user
- parentOrganizationId: Parent organization ID
Sort Structure:
[
{
"field": "field_name",
"direction": "asc|desc"
}
]
Default Sort: name (asc)
fieldsToReturnstring[]Comma-separated list of field names to include in response items. If not provided, all fields are returned.
Available Fields: id, name, shortName, type, color, isActive, email, phoneNumber, website, addressCity, addressCountry, addressStreet, addressZip, startOfCollaboration, createdAt, editedAt, isFavorite, parentOrganizationId, parentOrganizationName
Paginated list of organizations
Unauthorized - Invalid or missing authentication token
Forbidden - Insufficient API scopes or permissions