> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Sumble: Get Organization List

> Get organization list details. Includes SDK V2 and CLI requests, input constraints, response fields, and Deepline credit cost.

Get organization list details.

> [!NOTE]
>
> Tool ID: `sumble_get_organization_list`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'sumble_get_organization_list',
  {
    "list_id": 123
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute sumble_get_organization_list --input '{
  "list_id": 123
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "id": "123e4567-e89b-42d3-a456-426614174000",
    "list_info": {
      "id": 123,
      "name": "Example",
      "url": "https://example.com/resource",
      "organizations_count": 123,
      "type": "group",
      "read_only": true,
      "deletable": true
    },
    "organizations": [
      {
        "id": 1,
        "name": "Example",
        "slug": "example"
      }
    ]
  }
}
```

Use `deepline describe sumble_get_organization_list --json` for the latest machine-readable contract.

## Input reference

Get organization list details

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.list_id` | `integer` | Yes | — | — |
| `payload.include_deleted` | `boolean` | No | `false` | — |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Get organization list details",
    "properties": {
      "list_id": {
        "type": "integer"
      },
      "include_deleted": {
        "type": "boolean",
        "default": false
      }
    },
    "required": [
      "list_id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.id` | `string` | Yes | — | Format: `uuid`. |
| `result.data.list_info` | `object` | Yes | — | — |
| `result.data.list_info.id` | `integer` | Yes | — | — |
| `result.data.list_info.name` | `string` | Yes | — | — |
| `result.data.list_info.url` | `string` | Yes | — | Format: `uri`. Minimum length: 1. Maximum length: 2083. |
| `result.data.list_info.organizations_count` | `integer` | Yes | — | — |
| `result.data.list_info.type` | `"group" \| "user"` | Yes | — | Allowed: `group`, `user`. |
| `result.data.list_info.read_only` | `boolean` | Yes | — | — |
| `result.data.list_info.deletable` | `boolean` | Yes | — | — |
| `result.data.list_info.deleted` | `boolean` | No | `false` | — |
| `result.data.list_info.include_in_signals` | `boolean` | No | `true` | — |
| `result.data.organizations` | `array` | Yes | — | — |
| `result.data.organizations[].id` | `integer \| null` | No | — | — |
| `result.data.organizations[].name` | `string \| null` | No | — | — |
| `result.data.organizations[].slug` | `string \| null` | No | — | — |
| `result.data.organizations[].sumble_url` | `string \| null` | No | — | Format: `uri`. Minimum length: 1. Maximum length: 2083. |
| `result.data.organizations[].url` | `string \| null` | No | — | — |
| `result.data.organizations[].employee_count` | `integer \| null` | No | — | — |
| `result.data.organizations[].account_status` | `"is_customer" \| "is_in_crm" \| "is_not_in_crm"` | No | — | Allowed: `is_customer`, `is_in_crm`, `is_not_in_crm`. |
| `result.data.organizations[].crm_url` | `string \| null` | No | — | — |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "list_info": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer"
              },
              "name": {
                "type": "string"
              },
              "url": {
                "type": "string",
                "minLength": 1,
                "maxLength": 2083,
                "format": "uri"
              },
              "organizations_count": {
                "type": "integer"
              },
              "type": {
                "type": "string",
                "enum": [
                  "group",
                  "user"
                ]
              },
              "read_only": {
                "type": "boolean"
              },
              "deletable": {
                "type": "boolean"
              },
              "deleted": {
                "type": "boolean",
                "default": false
              },
              "include_in_signals": {
                "type": "boolean",
                "default": true
              }
            },
            "required": [
              "id",
              "name",
              "url",
              "organizations_count",
              "type",
              "read_only",
              "deletable"
            ],
            "additionalProperties": false
          },
          "organizations": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": [
                    "integer",
                    "null"
                  ]
                },
                "name": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "slug": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "sumble_url": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "minLength": 1,
                  "maxLength": 2083,
                  "format": "uri"
                },
                "url": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "employee_count": {
                  "type": [
                    "integer",
                    "null"
                  ]
                },
                "account_status": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "enum": [
                    "is_customer",
                    "is_in_crm",
                    "is_not_in_crm"
                  ]
                },
                "crm_url": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "additionalProperties": false
            }
          }
        },
        "required": [
          "id",
          "list_info",
          "organizations"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Sumble provider guide](https://deepline.com/docs/providers/sumble/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.