ContactShipInstall

Overview

This node interacts with the ContactShip API to manage boards related to contacts. Specifically, the "Get Board by ID" operation retrieves detailed information about a particular board and its stages within an organization. This is useful for workflows that need to access or display the structure and status of contact management boards, such as sales pipelines or project tracking boards.

Practical examples:

• Fetching a specific sales pipeline board to analyze its stages and progress.
• Retrieving a project board to visualize task stages and assignments.
• Integrating board data into dashboards or reports for real-time updates.

Properties

Output

The output JSON contains the full data of the requested board, including its metadata and an array of stages associated with it. Each stage typically includes details such as name, color, order, and other descriptive attributes.

Example structure (simplified):

{
  "id": "board-id",
  "name": "Board Name",
  "description": "Description of the board",
  "created_at": "2023-01-01T00:00:00Z",
  "stages": [
    {
      "id": "stage-id-1",
      "name": "Stage 1",
      "color": "#FF0000",
      "order": 1
    },
    {
      "id": "stage-id-2",
      "name": "Stage 2",
      "color": "#00FF00",
      "order": 2
    }
  ]
}

No binary data output is involved in this operation.

Dependencies

• Requires an active API key credential for the ContactShip API.
• The node depends on network connectivity to the ContactShip service base URL.
• The board options are dynamically loaded from the ContactShip API, so proper permissions and valid credentials are necessary.

Troubleshooting

• Common issues:

  • Invalid or expired API key will cause authentication failures.
  • Providing a non-existent or unauthorized board ID will result in errors or empty responses.
  • Network connectivity problems can prevent successful API calls.

• Error messages:

  • "Invalid API key" or authentication errors: Verify the API key credential and ensure it has correct permissions.
  • "Board not found" or similar: Confirm the board ID exists and the user has access rights.
  • "Network error" or timeouts: Check internet connection and ContactShip service status.

Links and References

• ContactShip API Documentation (hypothetical link)
• n8n documentation on Creating Custom Nodes