> ## 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.
# Zoho CRM: README
> Get portal details. Zoho CRM Portals Get Portal reference includes SDK V2 and CLI requests, input constraints, response fields, and Deepline cost.
Get portal details.
Tool ID: `zoho_crm_portals_get_portal`
## Run this action
Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.
```ts theme={null}
import { Deepline } from 'deepline';
const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
'zoho_crm_portals_get_portal',
{
"portal": "example"
},
);
console.log(result.toolResponse.raw);
```
### CLI
```bash theme={null}
deepline tools execute zoho_crm_portals_get_portal --input '{
"portal": "example"
}' --json
```
## Example response
The static output schema is not detailed enough to generate a reliable example. Use `deepline tools get zoho_crm_portals_get_portal --json` for the complete live contract.
## Input reference
Retrieve details for a specific portal by its identifier.
| Name | Type | Required | Default | Details |
| ---------------- | -------- | -------- | ------- | -------------------------------------- |
| `payload.portal` | `string` | Yes | — | Portal identifier Maximum length: 255. |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "Retrieve details for a specific portal by its identifier.",
"properties": {
"portal": {
"type": "string",
"description": "Portal identifier",
"maxLength": 255
}
},
"required": [
"portal"
],
"additionalProperties": false
}
```
## Output reference
Standard tool result payload.
| Name | Type | Required | Default | Details |
| ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `result.data` | `object` | Yes | — | Response object containing a list of portals with their details. |
| `result.data.portals` | `array` | Yes | — | Array of portal objects. Maximum items: 100. |
| `result.data.portals[].name` | `string` | No | — | Portal name. Maximum length: 50. |
| `result.data.portals[].created_time` | `string` | Yes | — | Portal creation timestamp. Format: `date-time`. |
| `result.data.portals[].modified_time` | `string` | Yes | — | Portal last modification timestamp. Format: `date-time`. |
| `result.data.portals[].modified_by` | `object` | Yes | — | User who last modified the portal. |
| `result.data.portals[].modified_by.name` | `string` | Yes | — | User name. Maximum length: 255. |
| `result.data.portals[].modified_by.id` | `string` | Yes | — | User ID. Maximum length: 255. |
| `result.data.portals[].created_by` | `object` | Yes | — | User who created the portal. |
| `result.data.portals[].created_by.name` | `string` | Yes | — | User name. Maximum length: 255. |
| `result.data.portals[].created_by.id` | `string` | Yes | — | User ID. Maximum length: 255. |
| `result.data.portals[].zaid` | `string` | Yes | — | Zoho account ID. Maximum length: 255. |
| `result.data.portals[].active` | `boolean` | Yes | — | Portal active status. |
| `result.data.portals[].saml_configuration` | `object \| null` | Yes | — | SAML configuration for the portal. |
| `result.data.portals[].saml_configuration.login_url` | `string` | Yes | — | SAML login URL. Maximum length: 2048. |
| `result.data.portals[].saml_configuration.logout_url` | `string` | Yes | — | SAML logout URL. Maximum length: 2048. Pattern: `http[s]://www[.][a-z]{7}[.]com`. |
| `result.data.portals[].saml_configuration.public_key` | `"-----BEGIN CERTIFICATE-----nMIICkTCCAXkCBgGFNDYS5DANBgkqhkiG9w0BAQsFADAMMQowCAYDVQQDEwFBMB4XDTIyMTIyMDEwMjM1N1oXDTI1MTIyMDEwMjM1N1owDDEKMAgGA1UEAxMBQTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAJ9JHZa/KoI1v4bl9HyDB2EB684y1P8hykirP0BoGpf2o4hj2ITjkhncbBJt9PFR8Cp8PmxL7UnGIZl/4g0VQMIxtq82UuvaC8uTZUQJeUDbrPEVMoN12YOF2sJ2AZ4gf3Pr6rf+kXYDp5T9gyFMFUzqNS/WL5xOpyzVJkROv69YbPkcLWms+orpcs+ADXXNfwhIfwF6ZLcNqgi1itX9T/vuvW5KEcU5QtOLLQdqNQ0Oi/0oiyIXhcsjGD1e+QSAtxdTpM44WkxOYW3TUj0+8EZOdU+Vj0lhgr61+bJHgnYiyA83LHqKcIKXEYVs70Lb3Ors4dU7XU6gBzxLnsf9nCECAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAUiTh+to8d/QKYh9yOLqE25PraBEVselNgNx8Dly//JXfXz42lzwG5WOY94bmUur2qYe8sVUqY07O/1XSW7QBrGMhGA9Hhvgz6zrRPzGPUVVQT3caTG/b+1pNLriga7OSam6rp1uL5emutkyyn6ZUZ7px4K1vGEx6/GBFsepGH5E2N0PRuekTp0eiV+5m+6z4VL7tVtYGQbWUfVgBqBUEhkdu450ry0jJT6SPs1W8TPBQEZQ/Pjis4MubIRKrUtkb+SkLDpBSWmXdoKlsIJt8VqhdqN04bmt91sB+XdgSC4X7ideK7WPcEj2DYna4v/YB13MitxQrKKU9uT/HNm1JHg==n-----END CERTIFICATE-----"` | Yes | — | SAML public key certificate. Allowed: \`-----BEGIN CERTIFICATE-----nMIICkTCCAXkCBgGFNDYS5DANBgkqhkiG9w0BAQsFADAMMQowCAYDVQQDEwFBMB4XDTIyMTIyMDEwMjM1N1oXDTI1MTIyMDEwMjM1N1owDDEKMAgGA1UEAxMBQTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAJ9JHZa/KoI1v4bl9HyDB2EB684y1P8hykirP0BoGpf2o4hj2ITjkhncbBJt9PFR8Cp8PmxL7UnGIZl/4g0VQMIxtq82UuvaC8uTZUQJeUDbrPEVMoN12YOF2sJ2AZ4gf3Pr6rf+kXYDp5T9gyFMFUzqNS/WL5xOpyzVJkROv69YbPkcLWms+orpcs+ADXXNfwhIfwF6ZLcNqgi1itX9T/vuvW5KEcU5QtOLLQdqNQ0Oi/0oiyIXhcsjGD1e+QSAtxdTpM44WkxOY See the live schema for the complete constraint. |
| `result.data.portals[].saml_configuration.active` | `true` | Yes | — | SAML configuration active status. Allowed: `true`. |
| `result.data.portals[].login_url` | `string` | No | — | Portal login URL. Maximum length: 2048. |
| `result.data.portals[].acs_url` | `string` | No | — | Portal ACS URL. Maximum length: 2048. |
| `result.data.portals[].admin_zuid` | `integer` | No | — | Admin user zone ID. Format: `int32`. |
| `result.data.portals[].default_relay_state_url` | `string` | No | — | Default relay state URL. Maximum length: 2048. |
| `result.data.portals[].issuer` | `string` | No | — | SAML issuer identifier. Maximum length: 2048. |
| `result.data.portals[].single_logout_url` | `string` | No | — | Single logout URL. Maximum length: 2048. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"type": "object",
"description": "Standard tool result payload.",
"properties": {
"data": {
"type": "object",
"description": "Response object containing a list of portals with their details.",
"properties": {
"portals": {
"type": "array",
"description": "Array of portal objects.",
"maxItems": 100,
"items": {
"type": "object",
"description": "Portal details object.",
"properties": {
"name": {
"type": "string",
"description": "Portal name.",
"maxLength": 50
},
"created_time": {
"type": "string",
"description": "Portal creation timestamp.",
"format": "date-time"
},
"modified_time": {
"type": "string",
"description": "Portal last modification timestamp.",
"format": "date-time"
},
"modified_by": {
"type": "object",
"description": "User who last modified the portal.",
"properties": {
"name": {
"type": "string",
"description": "User name.",
"maxLength": 255
},
"id": {
"type": "string",
"description": "User ID.",
"maxLength": 255
}
},
"required": [
"name",
"id"
],
"additionalProperties": false
},
"created_by": {
"type": "object",
"description": "User who created the portal.",
"properties": {
"name": {
"type": "string",
"description": "User name.",
"maxLength": 255
},
"id": {
"type": "string",
"description": "User ID.",
"maxLength": 255
}
},
"required": [
"name",
"id"
],
"additionalProperties": false
},
"zaid": {
"type": "string",
"description": "Zoho account ID.",
"maxLength": 255
},
"active": {
"type": "boolean",
"description": "Portal active status."
},
"saml_configuration": {
"type": [
"object",
"null"
],
"description": "SAML configuration for the portal.",
"properties": {
"login_url": {
"type": "string",
"description": "SAML login URL.",
"maxLength": 2048
},
"logout_url": {
"type": "string",
"description": "SAML logout URL.",
"maxLength": 2048,
"pattern": "http[s]://www[.][a-z]{7}[.]com"
},
"public_key": {
"type": "string",
"description": "SAML public key certificate.",
"maxLength": 5000,
"enum": [
"-----BEGIN CERTIFICATE-----nMIICkTCCAXkCBgGFNDYS5DANBgkqhkiG9w0BAQsFADAMMQowCAYDVQQDEwFBMB4XDTIyMTIyMDEwMjM1N1oXDTI1MTIyMDEwMjM1N1owDDEKMAgGA1UEAxMBQTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAJ9JHZa/KoI1v4bl9HyDB2EB684y1P8hykirP0BoGpf2o4hj2ITjkhncbBJt9PFR8Cp8PmxL7UnGIZl/4g0VQMIxtq82UuvaC8uTZUQJeUDbrPEVMoN12YOF2sJ2AZ4gf3Pr6rf+kXYDp5T9gyFMFUzqNS/WL5xOpyzVJkROv69YbPkcLWms+orpcs+ADXXNfwhIfwF6ZLcNqgi1itX9T/vuvW5KEcU5QtOLLQdqNQ0Oi/0oiyIXhcsjGD1e+QSAtxdTpM44WkxOYW3TUj0+8EZOdU+Vj0lhgr61+bJHgnYiyA83LHqKcIKXEYVs70Lb3Ors4dU7XU6gBzxLnsf9nCECAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAUiTh+to8d/QKYh9yOLqE25PraBEVselNgNx8Dly//JXfXz42lzwG5WOY94bmUur2qYe8sVUqY07O/1XSW7QBrGMhGA9Hhvgz6zrRPzGPUVVQT3caTG/b+1pNLriga7OSam6rp1uL5emutkyyn6ZUZ7px4K1vGEx6/GBFsepGH5E2N0PRuekTp0eiV+5m+6z4VL7tVtYGQbWUfVgBqBUEhkdu450ry0jJT6SPs1W8TPBQEZQ/Pjis4MubIRKrUtkb+SkLDpBSWmXdoKlsIJt8VqhdqN04bmt91sB+XdgSC4X7ideK7WPcEj2DYna4v/YB13MitxQrKKU9uT/HNm1JHg==n-----END CERTIFICATE-----"
]
},
"active": {
"type": "boolean",
"description": "SAML configuration active status.",
"enum": [
true
]
}
},
"required": [
"login_url",
"logout_url",
"public_key",
"active"
],
"additionalProperties": false
},
"login_url": {
"type": "string",
"description": "Portal login URL.",
"maxLength": 2048
},
"acs_url": {
"type": "string",
"description": "Portal ACS URL.",
"maxLength": 2048
},
"admin_zuid": {
"type": "integer",
"description": "Admin user zone ID.",
"format": "int32"
},
"default_relay_state_url": {
"type": "string",
"description": "Default relay state URL.",
"maxLength": 2048
},
"issuer": {
"type": "string",
"description": "SAML issuer identifier.",
"maxLength": 2048
},
"single_logout_url": {
"type": "string",
"description": "Single logout URL.",
"maxLength": 2048
}
},
"required": [
"created_time",
"modified_time",
"modified_by",
"created_by",
"zaid",
"active",
"saml_configuration"
],
"additionalProperties": false
}
}
},
"required": [
"portals"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"description": "Additional response metadata (status, paging).",
"additionalProperties": true
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## 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
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)