Get a comment

GET/v1/api/store/{team_slug}/comment/{id}

v1Operation ID v1_public_comment_show

Returns one comment by id, whatever it is on: a sales order, a quote, a job or a purchase order. Deleted comments are returned too, with trashed: true.

Comments are internal notes for your team; customers never see them. To list or add comments, use the operations on the sales order, job or purchase order.

Permission

Any member of the team, for any comment on the team. It does not check who wrote the comment or whether you can see its order.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team
• idstringrequired

  The comment's id. A hash id; unique keys and document numbers are refused with 404.

  • Example JiDNJJ08el0QrD

Request body

This operation takes no request body.

Response

200Successful response.

• dataobjectrequired
  Child fields (13)

  • commentstring

    The comment as HTML.

  • created_atstring (date-time)
  • idstring
  • is_editedboolean

    True once the comment changed after it was written. Deleting and restoring also count.

  • job_idstring | null

    Set for comments on a job.

  • job_namestring | null
  • job_scoped_idstring | null
  • order_idstring | null

    Set for comments on a sales order, a quote or one of their jobs.

  • purchase_order_idstring | null
  • trashedboolean

    True when the comment is deleted.

  • typestring

    user_comment for a comment written in YoPrint. user for one a team member sent by replying to a YoPrint email.

  • updated_atstring (date-time)
  • user_idstring

    The hash id of the team member who wrote it.

• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

  When

  No comment of this team has this id.

  Fix

  Use a comment id from the order's comment list.

Related

• PATCHEdit a comment without checks/v1/api/store/{team_slug}/comment/{id}
• DELETEDelete a comment/v1/api/store/{team_slug}/comment/{id}
• GETList the comments of an order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/comment/index

Example request

curl

curl 'https://secure.yoprint.com/v1/api/store/your-team/comment/JiDNJJ08el0QrD' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

Response

{
  "data": {
    "comment": "<p>Customer approved the blue ink.</p>",
    "created_at": "2026-11-03T09:30:00+00:00",
    "id": "JiDNJJ08el0QrD",
    "is_edited": false,
    "job_id": null,
    "job_name": null,
    "job_scoped_id": null,
    "order_id": "V4keXwwxMQyXw7",
    "purchase_order_id": null,
    "trashed": false,
    "type": "user_comment",
    "updated_at": "2026-11-03T09:30:00+00:00",
    "user_id": "VG7s3tFzyQbO2N"
  },
  "status": 200,
  "success": true
}