ContactShip icon

ContactShip

Interact with ContactShip API for AI Phone Calls
Join our community

Actions20

Overview

This node integrates with the ContactShip API to manage contacts and related entities such as tags, call history, comments, boards, and agents. Specifically, the "Get All Tags" operation under the "Contact" resource retrieves all tags available in your organization, optionally filtered and paginated.

Use cases include:

  • Fetching a list of tags to display or use in workflows for categorizing contacts.
  • Searching tags by text to find relevant labels.
  • Paginating through large sets of tags when managing contact metadata.

Example: You want to retrieve up to 50 tags starting from the 10th tag, sorted ascending, that contain the word "VIP". This node operation allows you to specify those parameters and get the matching tags.

Properties

Name Meaning
Options Collection of optional parameters to control the tag retrieval:
- Limit Number of tags to return (default 50)
- Offset Number of tags to skip before starting to collect results (default 0)
- Order Sort order of the tags; can be "Ascending" or "Descending" (default "Descending")
- Search Text string to filter tags containing this text (default empty)

Output

The output is a JSON object representing the response from the ContactShip API's /v1/tags endpoint. It contains:

  • data: An array of tag objects, each typically including properties like id, label (or name), and color.
  • Pagination information may also be included depending on the API response.

This output can be used downstream in workflows to reference tag IDs, names, or colors for further processing or filtering.

The node does not output binary data for this operation.

Dependencies

  • Requires an API key credential for authenticating with the ContactShip API.
  • The base URL for the ContactShip API must be configured in the credentials.
  • Network access to ContactShip API endpoints is necessary.

Troubleshooting

  • Invalid API Key or Credentials: If authentication fails, ensure the API key credential is correctly set up and has sufficient permissions.
  • Rate Limits or Quotas: Large requests or frequent calls might hit API rate limits; consider using pagination (limit and offset) to reduce load.
  • Empty Results: If no tags are returned, verify the search text and filters; also confirm that tags exist in the organization.
  • Invalid Parameter Values: Ensure numeric fields like limit and offset are non-negative integers and within allowed ranges.
  • Network Issues: Connectivity problems will cause request failures; check network settings and firewall rules.

Links and References

Discussion