> For the complete documentation index, see [llms.txt](https://docs.shortcutco.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.shortcutco.com/developers/api-reference/reference/activity.md).

# Activity

What happened with a customer: the timeline, posts, photos, and files.

The timeline is everything that happened with a customer, as the profile's Activity tab shows it. Posts are comments, call summaries, and photos and files on the feed. Files are opened through download links that work for 5 minutes.

Fields: [The timeline event object](https://docs.shortcutco.com/developers/reference/objects/timeline-event) · [The activity post object](https://docs.shortcutco.com/developers/reference/objects/activity-post) · [The attachment object](https://docs.shortcutco.com/developers/reference/objects/attachment).

## Get an activity post

> One post on a customer's or lead's activity feed, with fresh download links for its attachments.\
> \
> Returns \[the activity post object]\(<https://docs.shortcutco.com/developers/reference/objects/activity-post>).

```json
{"openapi":"3.1.0","info":{"title":"Shortcut API","version":"v1"},"tags":[{"name":"Activity","description":"The timeline is everything that happened with a customer, as the profile's Activity tab shows it. Posts are comments, call summaries, and photos and files on the feed. Files are opened through download links that work for 5 minutes.\n\nFields: [The timeline event object](https://docs.shortcutco.com/developers/reference/objects/timeline-event) · [The activity post object](https://docs.shortcutco.com/developers/reference/objects/activity-post) · [The attachment object](https://docs.shortcutco.com/developers/reference/objects/attachment)."}],"servers":[{"url":"https://api.shortcutco.com","description":"Production"}],"security":[{"bearerAuth":["activity:read"]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"scut_<env>_<id>_<secret>","description":"A workspace API token. Each operation lists the scopes it needs; `write` implies `read`, and `send`/`complete` are never implied."}},"headers":{"RateLimitLimit":{"schema":{"type":"integer"},"description":"Requests allowed in the tightest window."},"RateLimitRemaining":{"schema":{"type":"integer"},"description":"Requests left in that window."},"RateLimitReset":{"schema":{"type":"integer"},"description":"Seconds until that window resets."}},"schemas":{"ActivityPost":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The post's id."},"object":{"type":"string","const":"activity_post","description":"Always `activity_post`."},"customerId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"The customer the post is on."},"leadId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"The lead it was written on, for posts from before the lead became a customer."},"body":{"type":"string","description":"The post's text; empty for a post that is only photos or files."},"authorName":{"type":["string","null"],"description":"Who posted it."},"flaggedNegative":{"type":"boolean","description":"Whether it records a bad interaction, which counts toward the customer being at risk."},"propertyId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"The customer's property the post is about; null when it is about the whole account."},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"},"description":"Photos, videos, and files on the post, in order."},"createdAt":{"type":"string","format":"date-time","description":"When it was posted, ISO 8601 in UTC."},"editedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"When it was last edited."}},"required":["id","object","customerId","leadId","body","authorName","flaggedNegative","propertyId","attachments","createdAt","editedAt"],"additionalProperties":false,"description":"A post on a customer's activity feed: a comment, call summary, or photos and files."},"Attachment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The attachment's id. Pass it to `GET /v1/attachments/{id}` for a fresh link."},"object":{"type":"string","const":"attachment","description":"Always `attachment`."},"source":{"type":"string","enum":["activity_post","visit","estimate","inbox_email","project"],"description":"Where the file lives: a post on the activity feed, a visit (crew photos and videos), an estimate, an email in the Inbox (`inbox_email`), or a project (`project`)."},"type":{"type":"string","enum":["photo","video","file"],"description":"Photo, video, or any other file."},"filename":{"type":"string","description":"The file's name as uploaded."},"mimeType":{"type":"string","description":"The file's media type, e.g. `image/jpeg`."},"sizeBytes":{"type":"integer","description":"The file's size in bytes."},"durationSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"A video's length in seconds; null otherwise."},"createdAt":{"type":"string","format":"date-time","description":"When the file was added, ISO 8601 in UTC."},"downloadUrl":{"type":"string","format":"uri","description":"A link that downloads the file without a token. It works for 5 minutes and opens only this file; get the attachment again for a new one."},"downloadUrlExpiresAt":{"type":"string","format":"date-time","description":"When `downloadUrl` stops working, ISO 8601 in UTC."}},"required":["id","object","source","type","filename","mimeType","sizeBytes","durationSeconds","createdAt","downloadUrl","downloadUrlExpiresAt"],"additionalProperties":false,"description":"A photo, video, or file on a customer's profile."},"Error":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","description":"Error family, such as `invalid_request` or `permission`."},"code":{"type":"string","description":"Specific error code; see the errors page."},"message":{"type":"string","description":"A human-readable explanation."},"param":{"type":"string","description":"The input the error is about, such as `query.limit`."},"requiredScope":{"type":"string","description":"The scope the token is missing."},"requestId":{"type":"string","description":"Quote this id to support."},"docs":{"type":"string","description":"Link to the error's documentation."}},"required":["type","code","message","requestId","docs"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Unauthenticated":{"description":"The token is missing, invalid, expired, or revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"SubscriptionRequired":{"description":"The workspace's subscription needs attention.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Forbidden":{"description":"The token is missing a required scope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"No such object in this workspace.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"RateLimited":{"description":"Rate limited; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"InternalError":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Unavailable":{"description":"Temporarily unavailable; retry later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/v1/activity-posts/{id}":{"get":{"operationId":"activity_posts.get","tags":["Activity"],"summary":"Get an activity post","description":"One post on a customer's or lead's activity feed, with fresh download links for its attachments.\n\nReturns [the activity post object](https://docs.shortcutco.com/developers/reference/objects/activity-post).","parameters":[{"name":"id","in":"path","required":true,"description":"The object's id.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ActivityPost"},"meta":{"type":"object","properties":{},"additionalProperties":true,"description":"Facts about this request beside the object, such as `alreadyReminded` on a repeated reminder. Present only when there is something to report."}},"required":["data"],"additionalProperties":false}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"402":{"$ref":"#/components/responses/SubscriptionRequired"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/Unavailable"}}}}}}
```

## Edit an activity post

> Changes a post's text (the feed shows it as edited) and/or the customer's property it is about (\`propertyId\`; null for the whole account). Files on a post cannot be changed.\
> \
> Returns \[the activity post object]\(<https://docs.shortcutco.com/developers/reference/objects/activity-post>).

```json
{"openapi":"3.1.0","info":{"title":"Shortcut API","version":"v1"},"tags":[{"name":"Activity","description":"The timeline is everything that happened with a customer, as the profile's Activity tab shows it. Posts are comments, call summaries, and photos and files on the feed. Files are opened through download links that work for 5 minutes.\n\nFields: [The timeline event object](https://docs.shortcutco.com/developers/reference/objects/timeline-event) · [The activity post object](https://docs.shortcutco.com/developers/reference/objects/activity-post) · [The attachment object](https://docs.shortcutco.com/developers/reference/objects/attachment)."}],"servers":[{"url":"https://api.shortcutco.com","description":"Production"}],"security":[{"bearerAuth":["activity:write"]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"scut_<env>_<id>_<secret>","description":"A workspace API token. Each operation lists the scopes it needs; `write` implies `read`, and `send`/`complete` are never implied."}},"headers":{"RateLimitLimit":{"schema":{"type":"integer"},"description":"Requests allowed in the tightest window."},"RateLimitRemaining":{"schema":{"type":"integer"},"description":"Requests left in that window."},"RateLimitReset":{"schema":{"type":"integer"},"description":"Seconds until that window resets."}},"schemas":{"ActivityPost":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The post's id."},"object":{"type":"string","const":"activity_post","description":"Always `activity_post`."},"customerId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"The customer the post is on."},"leadId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"The lead it was written on, for posts from before the lead became a customer."},"body":{"type":"string","description":"The post's text; empty for a post that is only photos or files."},"authorName":{"type":["string","null"],"description":"Who posted it."},"flaggedNegative":{"type":"boolean","description":"Whether it records a bad interaction, which counts toward the customer being at risk."},"propertyId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"The customer's property the post is about; null when it is about the whole account."},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"},"description":"Photos, videos, and files on the post, in order."},"createdAt":{"type":"string","format":"date-time","description":"When it was posted, ISO 8601 in UTC."},"editedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"When it was last edited."}},"required":["id","object","customerId","leadId","body","authorName","flaggedNegative","propertyId","attachments","createdAt","editedAt"],"additionalProperties":false,"description":"A post on a customer's activity feed: a comment, call summary, or photos and files."},"Attachment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The attachment's id. Pass it to `GET /v1/attachments/{id}` for a fresh link."},"object":{"type":"string","const":"attachment","description":"Always `attachment`."},"source":{"type":"string","enum":["activity_post","visit","estimate","inbox_email","project"],"description":"Where the file lives: a post on the activity feed, a visit (crew photos and videos), an estimate, an email in the Inbox (`inbox_email`), or a project (`project`)."},"type":{"type":"string","enum":["photo","video","file"],"description":"Photo, video, or any other file."},"filename":{"type":"string","description":"The file's name as uploaded."},"mimeType":{"type":"string","description":"The file's media type, e.g. `image/jpeg`."},"sizeBytes":{"type":"integer","description":"The file's size in bytes."},"durationSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"A video's length in seconds; null otherwise."},"createdAt":{"type":"string","format":"date-time","description":"When the file was added, ISO 8601 in UTC."},"downloadUrl":{"type":"string","format":"uri","description":"A link that downloads the file without a token. It works for 5 minutes and opens only this file; get the attachment again for a new one."},"downloadUrlExpiresAt":{"type":"string","format":"date-time","description":"When `downloadUrl` stops working, ISO 8601 in UTC."}},"required":["id","object","source","type","filename","mimeType","sizeBytes","durationSeconds","createdAt","downloadUrl","downloadUrlExpiresAt"],"additionalProperties":false,"description":"A photo, video, or file on a customer's profile."},"Error":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","description":"Error family, such as `invalid_request` or `permission`."},"code":{"type":"string","description":"Specific error code; see the errors page."},"message":{"type":"string","description":"A human-readable explanation."},"param":{"type":"string","description":"The input the error is about, such as `query.limit`."},"requiredScope":{"type":"string","description":"The scope the token is missing."},"requestId":{"type":"string","description":"Quote this id to support."},"docs":{"type":"string","description":"Link to the error's documentation."}},"required":["type","code","message","requestId","docs"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Unauthenticated":{"description":"The token is missing, invalid, expired, or revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"SubscriptionRequired":{"description":"The workspace's subscription needs attention.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Forbidden":{"description":"The token is missing a required scope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"No such object in this workspace.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Conflict":{"description":"Conflict with the current state or an in-flight request with the same idempotency key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Unprocessable":{"description":"The request cannot be applied, or its idempotency key was used for a different request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"RateLimited":{"description":"Rate limited; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"InternalError":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Unavailable":{"description":"Temporarily unavailable; retry later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/v1/activity-posts/{id}":{"patch":{"operationId":"activity_posts.update","tags":["Activity"],"summary":"Edit an activity post","description":"Changes a post's text (the feed shows it as edited) and/or the customer's property it is about (`propertyId`; null for the whole account). Files on a post cannot be changed.\n\nReturns [the activity post object](https://docs.shortcutco.com/developers/reference/objects/activity-post).","parameters":[{"name":"id","in":"path","required":true,"description":"The object's id.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","maxLength":10000,"description":"The post's new text."},"propertyId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Move the post to one of the customer's properties; null makes it about the whole account."}},"additionalProperties":false}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ActivityPost"},"meta":{"type":"object","properties":{},"additionalProperties":true,"description":"Facts about this request beside the object, such as `alreadyReminded` on a repeated reminder. Present only when there is something to report."}},"required":["data"],"additionalProperties":false}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"402":{"$ref":"#/components/responses/SubscriptionRequired"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"422":{"$ref":"#/components/responses/Unprocessable"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/Unavailable"}}}}}}
```

## Get an attachment

> A photo, video, or file on a customer's activity feed, a visit, or an estimate, with a \`downloadUrl\` that works for 5 minutes and needs no token. Files on estimates also need \`estimates:read\`.\
> \
> Returns \[the attachment object]\(<https://docs.shortcutco.com/developers/reference/objects/attachment>).

```json
{"openapi":"3.1.0","info":{"title":"Shortcut API","version":"v1"},"tags":[{"name":"Activity","description":"The timeline is everything that happened with a customer, as the profile's Activity tab shows it. Posts are comments, call summaries, and photos and files on the feed. Files are opened through download links that work for 5 minutes.\n\nFields: [The timeline event object](https://docs.shortcutco.com/developers/reference/objects/timeline-event) · [The activity post object](https://docs.shortcutco.com/developers/reference/objects/activity-post) · [The attachment object](https://docs.shortcutco.com/developers/reference/objects/attachment)."}],"servers":[{"url":"https://api.shortcutco.com","description":"Production"}],"security":[{"bearerAuth":["activity:read"]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"scut_<env>_<id>_<secret>","description":"A workspace API token. Each operation lists the scopes it needs; `write` implies `read`, and `send`/`complete` are never implied."}},"headers":{"RateLimitLimit":{"schema":{"type":"integer"},"description":"Requests allowed in the tightest window."},"RateLimitRemaining":{"schema":{"type":"integer"},"description":"Requests left in that window."},"RateLimitReset":{"schema":{"type":"integer"},"description":"Seconds until that window resets."}},"schemas":{"Attachment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The attachment's id. Pass it to `GET /v1/attachments/{id}` for a fresh link."},"object":{"type":"string","const":"attachment","description":"Always `attachment`."},"source":{"type":"string","enum":["activity_post","visit","estimate","inbox_email","project"],"description":"Where the file lives: a post on the activity feed, a visit (crew photos and videos), an estimate, an email in the Inbox (`inbox_email`), or a project (`project`)."},"type":{"type":"string","enum":["photo","video","file"],"description":"Photo, video, or any other file."},"filename":{"type":"string","description":"The file's name as uploaded."},"mimeType":{"type":"string","description":"The file's media type, e.g. `image/jpeg`."},"sizeBytes":{"type":"integer","description":"The file's size in bytes."},"durationSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"A video's length in seconds; null otherwise."},"createdAt":{"type":"string","format":"date-time","description":"When the file was added, ISO 8601 in UTC."},"downloadUrl":{"type":"string","format":"uri","description":"A link that downloads the file without a token. It works for 5 minutes and opens only this file; get the attachment again for a new one."},"downloadUrlExpiresAt":{"type":"string","format":"date-time","description":"When `downloadUrl` stops working, ISO 8601 in UTC."}},"required":["id","object","source","type","filename","mimeType","sizeBytes","durationSeconds","createdAt","downloadUrl","downloadUrlExpiresAt"],"additionalProperties":false,"description":"A photo, video, or file on a customer's profile."},"Error":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","description":"Error family, such as `invalid_request` or `permission`."},"code":{"type":"string","description":"Specific error code; see the errors page."},"message":{"type":"string","description":"A human-readable explanation."},"param":{"type":"string","description":"The input the error is about, such as `query.limit`."},"requiredScope":{"type":"string","description":"The scope the token is missing."},"requestId":{"type":"string","description":"Quote this id to support."},"docs":{"type":"string","description":"Link to the error's documentation."}},"required":["type","code","message","requestId","docs"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Unauthenticated":{"description":"The token is missing, invalid, expired, or revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"SubscriptionRequired":{"description":"The workspace's subscription needs attention.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Forbidden":{"description":"The token is missing a required scope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"No such object in this workspace.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"RateLimited":{"description":"Rate limited; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"InternalError":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Unavailable":{"description":"Temporarily unavailable; retry later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/v1/attachments/{id}":{"get":{"operationId":"attachments.get","tags":["Activity"],"summary":"Get an attachment","description":"A photo, video, or file on a customer's activity feed, a visit, or an estimate, with a `downloadUrl` that works for 5 minutes and needs no token. Files on estimates also need `estimates:read`.\n\nReturns [the attachment object](https://docs.shortcutco.com/developers/reference/objects/attachment).","parameters":[{"name":"id","in":"path","required":true,"description":"The object's id.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Attachment"},"meta":{"type":"object","properties":{},"additionalProperties":true,"description":"Facts about this request beside the object, such as `alreadyReminded` on a repeated reminder. Present only when there is something to report."}},"required":["data"],"additionalProperties":false}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"402":{"$ref":"#/components/responses/SubscriptionRequired"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/Unavailable"}}}}}}
```

## List a customer's activity posts

> Posts on the customer's activity feed, newest first, including posts from when they were a lead: comments, call summaries, and photos, videos, and files. Each attachment carries a \`downloadUrl\` that works for 5 minutes.\
> \
> Returns a list of \[activity post objects]\(<https://docs.shortcutco.com/developers/reference/objects/activity-post>).

```json
{"openapi":"3.1.0","info":{"title":"Shortcut API","version":"v1"},"tags":[{"name":"Activity","description":"The timeline is everything that happened with a customer, as the profile's Activity tab shows it. Posts are comments, call summaries, and photos and files on the feed. Files are opened through download links that work for 5 minutes.\n\nFields: [The timeline event object](https://docs.shortcutco.com/developers/reference/objects/timeline-event) · [The activity post object](https://docs.shortcutco.com/developers/reference/objects/activity-post) · [The attachment object](https://docs.shortcutco.com/developers/reference/objects/attachment)."}],"servers":[{"url":"https://api.shortcutco.com","description":"Production"}],"security":[{"bearerAuth":["customers:read","activity:read"]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"scut_<env>_<id>_<secret>","description":"A workspace API token. Each operation lists the scopes it needs; `write` implies `read`, and `send`/`complete` are never implied."}},"headers":{"RateLimitLimit":{"schema":{"type":"integer"},"description":"Requests allowed in the tightest window."},"RateLimitRemaining":{"schema":{"type":"integer"},"description":"Requests left in that window."},"RateLimitReset":{"schema":{"type":"integer"},"description":"Seconds until that window resets."}},"schemas":{"ActivityPost":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The post's id."},"object":{"type":"string","const":"activity_post","description":"Always `activity_post`."},"customerId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"The customer the post is on."},"leadId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"The lead it was written on, for posts from before the lead became a customer."},"body":{"type":"string","description":"The post's text; empty for a post that is only photos or files."},"authorName":{"type":["string","null"],"description":"Who posted it."},"flaggedNegative":{"type":"boolean","description":"Whether it records a bad interaction, which counts toward the customer being at risk."},"propertyId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"The customer's property the post is about; null when it is about the whole account."},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"},"description":"Photos, videos, and files on the post, in order."},"createdAt":{"type":"string","format":"date-time","description":"When it was posted, ISO 8601 in UTC."},"editedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"When it was last edited."}},"required":["id","object","customerId","leadId","body","authorName","flaggedNegative","propertyId","attachments","createdAt","editedAt"],"additionalProperties":false,"description":"A post on a customer's activity feed: a comment, call summary, or photos and files."},"Attachment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The attachment's id. Pass it to `GET /v1/attachments/{id}` for a fresh link."},"object":{"type":"string","const":"attachment","description":"Always `attachment`."},"source":{"type":"string","enum":["activity_post","visit","estimate","inbox_email","project"],"description":"Where the file lives: a post on the activity feed, a visit (crew photos and videos), an estimate, an email in the Inbox (`inbox_email`), or a project (`project`)."},"type":{"type":"string","enum":["photo","video","file"],"description":"Photo, video, or any other file."},"filename":{"type":"string","description":"The file's name as uploaded."},"mimeType":{"type":"string","description":"The file's media type, e.g. `image/jpeg`."},"sizeBytes":{"type":"integer","description":"The file's size in bytes."},"durationSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"A video's length in seconds; null otherwise."},"createdAt":{"type":"string","format":"date-time","description":"When the file was added, ISO 8601 in UTC."},"downloadUrl":{"type":"string","format":"uri","description":"A link that downloads the file without a token. It works for 5 minutes and opens only this file; get the attachment again for a new one."},"downloadUrlExpiresAt":{"type":"string","format":"date-time","description":"When `downloadUrl` stops working, ISO 8601 in UTC."}},"required":["id","object","source","type","filename","mimeType","sizeBytes","durationSeconds","createdAt","downloadUrl","downloadUrlExpiresAt"],"additionalProperties":false,"description":"A photo, video, or file on a customer's profile."},"Error":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","description":"Error family, such as `invalid_request` or `permission`."},"code":{"type":"string","description":"Specific error code; see the errors page."},"message":{"type":"string","description":"A human-readable explanation."},"param":{"type":"string","description":"The input the error is about, such as `query.limit`."},"requiredScope":{"type":"string","description":"The scope the token is missing."},"requestId":{"type":"string","description":"Quote this id to support."},"docs":{"type":"string","description":"Link to the error's documentation."}},"required":["type","code","message","requestId","docs"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Unauthenticated":{"description":"The token is missing, invalid, expired, or revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"SubscriptionRequired":{"description":"The workspace's subscription needs attention.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Forbidden":{"description":"The token is missing a required scope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"No such object in this workspace.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"RateLimited":{"description":"Rate limited; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"InternalError":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Unavailable":{"description":"Temporarily unavailable; retry later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/v1/customers/{id}/activity-posts":{"get":{"operationId":"customers.activity_posts.list","tags":["Activity"],"summary":"List a customer's activity posts","description":"Posts on the customer's activity feed, newest first, including posts from when they were a lead: comments, call summaries, and photos, videos, and files. Each attachment carries a `downloadUrl` that works for 5 minutes.\n\nReturns a list of [activity post objects](https://docs.shortcutco.com/developers/reference/objects/activity-post).","parameters":[{"name":"id","in":"path","required":true,"description":"The object's id.","schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","required":false,"description":"How many items to return, 1-200. Defaults to 50.","schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"cursor","in":"query","required":false,"description":"The `meta.nextCursor` from the previous page. Omit it for the first page.","schema":{"type":"string","minLength":1,"maxLength":4096}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ActivityPost"}},"meta":{"type":"object","properties":{"nextCursor":{"type":["string","null"],"description":"Pass as `cursor` to get the next page; null on the last page."},"hasMore":{"type":"boolean","description":"Whether another page exists."}},"required":["nextCursor","hasMore"],"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"402":{"$ref":"#/components/responses/SubscriptionRequired"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/Unavailable"}}}}}}
```

## Post to a customer's activity feed

> Posts a comment, call summary, or photos and documents to the customer's activity feed, in the name of the admin the token or app acts for. Files are sent inline as base64 (photos: JPEG, PNG, WebP, HEIC; documents: PDF, text, CSV, Word, Excel), up to 700 KB in all. \`flaggedNegative\` marks a bad interaction. Send an \`Idempotency-Key\`: a retry with the same key returns the post it made.\
> \
> Returns \[the activity post object]\(<https://docs.shortcutco.com/developers/reference/objects/activity-post).\\>
> \
> \*\*Errors specific to this endpoint:\*\* \[\`attachments\_unavailable\`]\(<https://docs.shortcutco.com/developers/concepts/errors#attachments\\_unavailable>). Every endpoint can also return the \[common errors]\(<https://docs.shortcutco.com/developers/concepts/errors>).

```json
{"openapi":"3.1.0","info":{"title":"Shortcut API","version":"v1"},"tags":[{"name":"Activity","description":"The timeline is everything that happened with a customer, as the profile's Activity tab shows it. Posts are comments, call summaries, and photos and files on the feed. Files are opened through download links that work for 5 minutes.\n\nFields: [The timeline event object](https://docs.shortcutco.com/developers/reference/objects/timeline-event) · [The activity post object](https://docs.shortcutco.com/developers/reference/objects/activity-post) · [The attachment object](https://docs.shortcutco.com/developers/reference/objects/attachment)."}],"servers":[{"url":"https://api.shortcutco.com","description":"Production"}],"security":[{"bearerAuth":["customers:read","activity:write"]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"scut_<env>_<id>_<secret>","description":"A workspace API token. Each operation lists the scopes it needs; `write` implies `read`, and `send`/`complete` are never implied."}},"parameters":{"IdempotencyKey":{"name":"Idempotency-Key","in":"header","required":false,"description":"Any string up to 255 characters. Retrying with the same key returns the first response instead of repeating the write, for 24 hours.","schema":{"type":"string","maxLength":255}}},"headers":{"RateLimitLimit":{"schema":{"type":"integer"},"description":"Requests allowed in the tightest window."},"RateLimitRemaining":{"schema":{"type":"integer"},"description":"Requests left in that window."},"RateLimitReset":{"schema":{"type":"integer"},"description":"Seconds until that window resets."}},"schemas":{"ActivityPost":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The post's id."},"object":{"type":"string","const":"activity_post","description":"Always `activity_post`."},"customerId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"The customer the post is on."},"leadId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"The lead it was written on, for posts from before the lead became a customer."},"body":{"type":"string","description":"The post's text; empty for a post that is only photos or files."},"authorName":{"type":["string","null"],"description":"Who posted it."},"flaggedNegative":{"type":"boolean","description":"Whether it records a bad interaction, which counts toward the customer being at risk."},"propertyId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"The customer's property the post is about; null when it is about the whole account."},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"},"description":"Photos, videos, and files on the post, in order."},"createdAt":{"type":"string","format":"date-time","description":"When it was posted, ISO 8601 in UTC."},"editedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"When it was last edited."}},"required":["id","object","customerId","leadId","body","authorName","flaggedNegative","propertyId","attachments","createdAt","editedAt"],"additionalProperties":false,"description":"A post on a customer's activity feed: a comment, call summary, or photos and files."},"Attachment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The attachment's id. Pass it to `GET /v1/attachments/{id}` for a fresh link."},"object":{"type":"string","const":"attachment","description":"Always `attachment`."},"source":{"type":"string","enum":["activity_post","visit","estimate","inbox_email","project"],"description":"Where the file lives: a post on the activity feed, a visit (crew photos and videos), an estimate, an email in the Inbox (`inbox_email`), or a project (`project`)."},"type":{"type":"string","enum":["photo","video","file"],"description":"Photo, video, or any other file."},"filename":{"type":"string","description":"The file's name as uploaded."},"mimeType":{"type":"string","description":"The file's media type, e.g. `image/jpeg`."},"sizeBytes":{"type":"integer","description":"The file's size in bytes."},"durationSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"A video's length in seconds; null otherwise."},"createdAt":{"type":"string","format":"date-time","description":"When the file was added, ISO 8601 in UTC."},"downloadUrl":{"type":"string","format":"uri","description":"A link that downloads the file without a token. It works for 5 minutes and opens only this file; get the attachment again for a new one."},"downloadUrlExpiresAt":{"type":"string","format":"date-time","description":"When `downloadUrl` stops working, ISO 8601 in UTC."}},"required":["id","object","source","type","filename","mimeType","sizeBytes","durationSeconds","createdAt","downloadUrl","downloadUrlExpiresAt"],"additionalProperties":false,"description":"A photo, video, or file on a customer's profile."},"Error":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","description":"Error family, such as `invalid_request` or `permission`."},"code":{"type":"string","description":"Specific error code; see the errors page."},"message":{"type":"string","description":"A human-readable explanation."},"param":{"type":"string","description":"The input the error is about, such as `query.limit`."},"requiredScope":{"type":"string","description":"The scope the token is missing."},"requestId":{"type":"string","description":"Quote this id to support."},"docs":{"type":"string","description":"Link to the error's documentation."}},"required":["type","code","message","requestId","docs"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Unauthenticated":{"description":"The token is missing, invalid, expired, or revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"SubscriptionRequired":{"description":"The workspace's subscription needs attention.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Forbidden":{"description":"The token is missing a required scope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"No such object in this workspace.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Conflict":{"description":"Conflict with the current state or an in-flight request with the same idempotency key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Unprocessable":{"description":"The request cannot be applied, or its idempotency key was used for a different request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"RateLimited":{"description":"Rate limited; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"InternalError":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Unavailable":{"description":"Temporarily unavailable; retry later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/v1/customers/{id}/activity-posts":{"post":{"operationId":"customers.activity_posts.create","tags":["Activity"],"summary":"Post to a customer's activity feed","description":"Posts a comment, call summary, or photos and documents to the customer's activity feed, in the name of the admin the token or app acts for. Files are sent inline as base64 (photos: JPEG, PNG, WebP, HEIC; documents: PDF, text, CSV, Word, Excel), up to 700 KB in all. `flaggedNegative` marks a bad interaction. Send an `Idempotency-Key`: a retry with the same key returns the post it made.\n\nReturns [the activity post object](https://docs.shortcutco.com/developers/reference/objects/activity-post).\n\n**Errors specific to this endpoint:** [`attachments_unavailable`](https://docs.shortcutco.com/developers/concepts/errors#attachments_unavailable). Every endpoint can also return the [common errors](https://docs.shortcutco.com/developers/concepts/errors).","parameters":[{"name":"id","in":"path","required":true,"description":"The object's id.","schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","maxLength":10000,"default":"","description":"The post's text. A post needs text or at least one file."},"flaggedNegative":{"type":"boolean","default":false,"description":"Mark it as a bad interaction (a complaint, a hard call); it counts toward the customer being at risk for 90 days."},"attachments":{"type":"array","items":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"maxLength":200,"description":"The file's name."},"mimeType":{"type":"string","description":"The file's type: a photo (`image/jpeg`, `image/png`, `image/webp`, `image/heic`) or a document (PDF, text, CSV, Word, Excel)."},"contentBase64":{"type":"string","minLength":1,"description":"The file's bytes, base64. All files in one request together: at most 700 KB."}},"required":["filename","mimeType","contentBase64"],"additionalProperties":false},"maxItems":10,"default":[],"description":"Photos and files to attach, up to 10."},"propertyId":{"type":"string","format":"uuid","description":"The customer's property the post is about (`GET /v1/customers/{id}/properties`); leave out for the whole account."}},"additionalProperties":false,"description":"A post on a customer's activity feed."}}}},"responses":{"201":{"description":"Success.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ActivityPost"},"meta":{"type":"object","properties":{},"additionalProperties":true,"description":"Facts about this request beside the object, such as `alreadyReminded` on a repeated reminder. Present only when there is something to report."}},"required":["data"],"additionalProperties":false}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"402":{"$ref":"#/components/responses/SubscriptionRequired"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"422":{"$ref":"#/components/responses/Unprocessable"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/Unavailable"}}}}}}
```
