InNotes icon

InNotes

Consume InNotes CRM API

Actions22

Status → Get All

AI-generated

Overview

This node operation retrieves all statuses of a specified type from the InNotes CRM API. It is useful for scenarios where you need to fetch and display or process all status entries related to contacts or jobs within the CRM system. For example, you might use this operation to populate a dropdown list of statuses in a workflow or to analyze the status distribution of contacts or jobs.

Use Case Examples

  1. Fetch all contact statuses to display in a user interface.
  2. Retrieve all job statuses for reporting or automation purposes.

Properties

Name Meaning
Type The type of status to retrieve, either 'contact' or 'job'.

Output

JSON

  • id - Unique identifier of the status.
  • name - Name of the status.
  • type - Type of the status, e.g., contact or job.
  • color - Optional color associated with the status.

Dependencies

  • Requires an API key credential for the InNotes CRM API to authenticate requests.

Troubleshooting

  • Common issues include authentication failures due to missing or incorrect API credentials. Ensure the API key is correctly configured in the node credentials.
  • API request failures might occur if the specified status type is invalid or the API endpoint is unreachable. Verify the 'Type' property and network connectivity.
  • Error messages from the API are wrapped in NodeApiError with descriptive messages to help identify the cause.

Links

Discussion