Tool ID:
pipedrive_get_organizationsRun this action
Use the TypeScript SDK for a single call. Putctx.tools.execute(...) inside a Play when the call should be durable, scheduled, or run across a CSV.
import { Deepline } from 'deepline';
const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
'pipedrive_get_organizations',
{
"filter_id": 123,
"ids": "example",
"owner_id": 123
},
);
console.log(result.toolResponse.raw);
CLI
deepline tools execute pipedrive_get_organizations --input '{
"filter_id": 123,
"ids": "example",
"owner_id": 123
}' --json
Example response
The SDK exposes this shape atresult.toolResponse.raw. Values below are representative.
{
"data": {
"success": true,
"data": [
{
"id": 123,
"name": "Example",
"owner_id": 123
}
],
"additional_data": {
"next_cursor": "cursor_123"
}
}
}
deepline tools get pipedrive_get_organizations --json for the latest machine-readable contract.
Input reference
Returns data about all organizations.| Name | Type | Required | Default | Details |
|---|---|---|---|---|
payload.filter_id | integer | No | — | If supplied, only organizations matching the specified filter are returned |
payload.ids | string | No | — | Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response. |
payload.owner_id | integer | No | — | If supplied, only organizations owned by the specified user are returned. If filter_id is provided, this is ignored. |
payload.updated_since | string | No | — | If set, only organizations with an update_time later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. |
payload.updated_until | string | No | — | If set, only organizations with an update_time earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. |
payload.sort_by | "id" | "update_time" | "add_time" | No | "id" | The field to sort by. Supported fields: id, update_time, add_time. Allowed: id, update_time, add_time. |
payload.sort_direction | "asc" | "desc" | No | "asc" | The sorting direction. Supported values: asc, desc. Allowed: asc, desc. |
payload.include_fields | "next_activity_id" | "last_activity_id" | "open_deals_count" | "related_open_deals_count" | "closed_deals_count" | "related_closed_deals_count" | "email_messages_count" | "people_count" | "activities_count" | "done_activities_count" | "undone_activities_count" | "files_count" | "notes_count" | "followers_count" | "won_deals_count" | "related_won_deals_count" | "lost_deals_count" | "related_lost_deals_count" | "smart_bcc_email" | No | — | Optional comma separated string array of additional fields to include Allowed: next_activity_id, last_activity_id, open_deals_count, related_open_deals_count, closed_deals_count, related_closed_deals_count, email_messages_count, people_count, activities_count, done_activities_count, undone_activities_count, files_count, notes_count, followers_count, won_deals_count, related_won_deals_count, lost_deals_count, related_lost_deals_count, smart_bcc_email. |
payload.custom_fields | string | No | — | Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response. A maximum of 15 keys is allowed. |
payload.include_option_labels | boolean | No | — | When provided with a ‘true’ value, single option and multiple option custom fields values contain objects in the form of ’{ id: number, label: string }’ instead of plain id |
payload.include_labels | boolean | No | — | When provided with ‘true’ value, response will include an array of label objects in the form of ’{ id: number, label: string }‘ |
payload.limit | integer | No | — | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. |
payload.cursor | string | No | — | For pagination, the marker (an opaque string value) representing the first item on the next page |
Output reference
Standard tool result payload.| Name | Type | Required | Default | Details |
|---|---|---|---|---|
result.data | object | Yes | — | Provider response payload. |
result.data.success | boolean | No | — | If the response is successful or not |
result.data.data | array | No | — | Organizations array |
result.data.data[].id | integer | No | — | The ID of the organization |
result.data.data[].name | string | No | — | The name of the organization |
result.data.data[].owner_id | integer | No | — | The ID of the user who owns the organization |
result.data.data[].add_time | string | No | — | The creation date and time of the organization |
result.data.data[].update_time | string | No | — | The last updated date and time of the organization |
result.data.data[].is_deleted | boolean | No | — | Whether the organization is deleted or not |
result.data.data[].visible_to | integer | No | — | The visibility of the organization |
result.data.data[].address | object | No | — | The address of the organization |
result.data.data[].address.value | string | No | — | The full address of the organization |
result.data.data[].address.country | string | No | — | Country of the organization |
result.data.data[].address.admin_area_level_1 | string | No | — | Admin area level 1 (e.g. state) of the organization |
result.data.data[].address.admin_area_level_2 | string | No | — | Admin area level 2 (e.g. county) of the organization |
result.data.data[].address.locality | string | No | — | Locality (e.g. city) of the organization |
result.data.data[].address.sublocality | string | No | — | Sublocality (e.g. neighborhood) of the organization |
result.data.data[].address.route | string | No | — | Route (e.g. street) of the organization |
result.data.data[].address.street_number | string | No | — | Street number of the organization |
result.data.data[].address.subpremise | string | No | — | Subpremise (e.g. apartment/suite number) of the organization |
result.data.data[].address.postal_code | string | No | — | Postal code of the organization |
result.data.data[].label_ids | array | No | — | The IDs of labels assigned to the organization |
result.data.data[].website | string | null | No | — | The website of the organization |
result.data.data[].linkedin | string | null | No | — | The LinkedIn profile URL of the organization |
result.data.data[].industry | integer | null | No | — | The industry the organization belongs to |
result.data.data[].annual_revenue | integer | null | No | — | The annual revenue of the organization |
result.data.data[].employee_count | integer | null | No | — | The number of employees in the organization |
result.data.data[].custom_fields | record | No | — | An object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes. To clear a custom field value, set it to null. For multi-option fields (field type set), use null to clear the selection — sending an empty array [] is not supported and will result in a validation error. |
result.data.additional_data | object | No | — | The additional data of the list |
result.data.additional_data.next_cursor | string | No | — | The first item on the next page. The value of the next_cursor field will be null if you have reached the end of the dataset and there’s no more pages to be returned. |
result.meta | object | No | — | Additional response metadata (status, paging). |
Deepline cost
- Pricing model:
fixed(per call). - Estimated Deepline credits:
0per pricing unit. - Provider-native pricing may still exist outside Deepline credit billing.