GET
/
v1
/
contacts
/
{contactId}
/
comments
# Retrieve all comments for a specific contact
curl -X GET "https://api.contactship.ai/v1/contacts/c1a2b3c4-d5e6-f7g8-h9i0-j1k2l3m4n5o6/comments" \
  -H "x-api-key: your-api-key"

[
  {
    "id": "d5e6f7g8-h9i0-j1k2-l3m4-n5o6p7q8r9s0",
    "created_at": "2023-03-10T09:15:00Z",
    "updated_at": "2023-03-10T09:15:00Z",
    "content": "Cliente interesado en el plan premium. Programar seguimiento para la próxima semana.",
    "user_id": "u1v2w3x4-y5z6-a7b8-c9d0-e1f2g3h4i5j6",
    "user_name": "Ana García",
    "contact_id": "c1a2b3c4-d5e6-f7g8-h9i0-j1k2l3m4n5o6",
    "organization_id": "org123456"
  },
  {
    "id": "f7g8h9i0-j1k2-l3m4-n5o6-p7q8r9s0t1u2",
    "created_at": "2023-02-20T14:30:00Z",
    "updated_at": "2023-02-21T10:45:00Z",
    "content": "Primera llamada completada. El cliente solicitó más información sobre los precios.",
    "user_id": "v2w3x4y5-z6a7-b8c9-d0e1-f2g3h4i5j6k7",
    "user_name": "Carlos Rodríguez",
    "contact_id": "c1a2b3c4-d5e6-f7g8-h9i0-j1k2l3m4n5o6",
    "organization_id": "org123456"
  }
]

This endpoint allows you to retrieve all comments and notes that have been added to a specific contact. Comments provide historical context about interactions with the contact and can be helpful for team collaboration.

​
Use Cases

  • Review the conversation history with a contact
  • Prepare for a call or meeting by reviewing previous interactions
  • Track the progress of a relationship with a contact
  • Ensure team members are aware of important notes about the contact
  • Generate reports on engagement history

​
Path Parameters

​
contactId
string
required

The unique identifier of the contact whose comments you want to retrieve. This is a UUID string that was generated when the contact was created.

​
Headers

​
x-api-key
string
required

Your API key for authentication. You can find this in your dashboard under API settings.

​
Query Parameters

​
limit
number

The maximum number of comments to return. Defaults to 50, maximum allowed is 100.

​
offset
number

The number of comments to skip before starting to return results. Used for pagination. Defaults to 0.

​
sort
string

The sort order for the comments. Possible values: newest (default), oldest.

​
Response

​
status code
number

200 on success

​
data
array

Array of comment objects

​
Error Codes

  • 400 Bad Request - Invalid request parameters
  • 401 Unauthorized - Invalid or missing API key
  • 404 Not Found - Contact not found
  • 500 Internal Server Error - Server-side error

​
Code Examples

# Retrieve all comments for a specific contact
curl -X GET "https://api.contactship.ai/v1/contacts/c1a2b3c4-d5e6-f7g8-h9i0-j1k2l3m4n5o6/comments" \
  -H "x-api-key: your-api-key"

[
  {
    "id": "d5e6f7g8-h9i0-j1k2-l3m4-n5o6p7q8r9s0",
    "created_at": "2023-03-10T09:15:00Z",
    "updated_at": "2023-03-10T09:15:00Z",
    "content": "Cliente interesado en el plan premium. Programar seguimiento para la próxima semana.",
    "user_id": "u1v2w3x4-y5z6-a7b8-c9d0-e1f2g3h4i5j6",
    "user_name": "Ana García",
    "contact_id": "c1a2b3c4-d5e6-f7g8-h9i0-j1k2l3m4n5o6",
    "organization_id": "org123456"
  },
  {
    "id": "f7g8h9i0-j1k2-l3m4-n5o6-p7q8r9s0t1u2",
    "created_at": "2023-02-20T14:30:00Z",
    "updated_at": "2023-02-21T10:45:00Z",
    "content": "Primera llamada completada. El cliente solicitó más información sobre los precios.",
    "user_id": "v2w3x4y5-z6a7-b8c9-d0e1-f2g3h4i5j6k7",
    "user_name": "Carlos Rodríguez",
    "contact_id": "c1a2b3c4-d5e6-f7g8-h9i0-j1k2l3m4n5o6",
    "organization_id": "org123456"
  }
]

​
Notes and Best Practices

  • Use the sort parameter to display comments in the most useful order for your use case
  • Implement pagination in your application if the contact has many comments
  • Store comment IDs if you need to reference specific comments later
  • Consider implementing a comment categorization system in your application to better organize feedback
  • Keep sensitive information out of comments when possible, as they may be visible to multiple team members