ContactShip icon

ContactShip

Interact with ContactShip API for AI Phone Calls
Join our community

Actions20

Overview

The node integrates with the ContactShip API to manage contacts, agents, calls, boards, and related entities within an organization. Specifically, for the Contact resource and the Get All Boards operation, it retrieves all boards associated with the organization filtered by a specified entity type (either "CONTACT" or "AGENT"). This is useful for workflows that need to list or process organizational boards related to contacts or agents.

Practical examples:

  • Fetching all contact-related boards to display in a dashboard.
  • Automating processes that assign contacts or agents to specific boards.
  • Integrating board data into CRM or project management systems.

Properties

Name Meaning
Entity Type Type of entity to filter boards. Options: "CONTACT" or "AGENT". Determines which boards are retrieved based on the entity type.

Output

The output JSON contains the data returned from the ContactShip API endpoint /v1/board/list. It includes a list of boards filtered by the selected entity type. Each board object typically contains fields such as:

  • id: Unique identifier of the board.
  • name: Name of the board.
  • description: Description or notes about the board.
  • created_at: Timestamp when the board was created.

The output structure is:

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "created_at": "string"
    },
    ...
  ]
}

No binary data is output by this operation.

Dependencies

  • Requires an API key credential for authenticating with the ContactShip API.
  • The node uses the ContactShip API base URL and API key from configured credentials.
  • No additional external dependencies beyond the ContactShip API.

Troubleshooting

  • Invalid API Key or Authentication Errors: Ensure the API key credential is correctly configured and has sufficient permissions.
  • Empty or Missing Board Data: Verify that the organization has boards created for the specified entity type ("CONTACT" or "AGENT").
  • Network or API Request Failures: Check network connectivity and ContactShip API status.
  • Invalid Entity Type: Only "CONTACT" or "AGENT" are valid; using other values will result in no data or errors.

Common error messages:

  • "Invalid 'entityType' parameter": Use one of the allowed options.
  • "Unauthorized" or "Authentication failed": Check API key validity.
  • "Request failed": Inspect network or API endpoint availability.

Links and References

Discussion