Recent activity

Overview

Get a feed of recent changes across your partner: sub-partners, accounts, locations and users added, edited or removed.

Use this for an activity panel.

You'll need a partner token.

Returns recent events, newest first, a page at a time.

Prerequisites

A Partner bearer token. See Authentication.

Base URL

Environment	URL
Production	`https://production-api.shoutaboutus.com`
Development	`https://development-api.shoutaboutus.com`

Endpoint

GET /api/v1/partner/stats/activities

Authentication

Partner token

Activities cover your own partner and the accounts and sub-partners directly under it.
When the user behind the token is limited to some accounts, only those accounts' activities are returned.

Rate limit

120 requests per minute, counted per user (the token’s user). See Rate limits.

Request parameters

Parameter	In	Type	Required	Description
`limit`	query	integer	No	Activities per page, 10 to 100. Values below 10 are raised to 10; above 100 returns `422`. Default 10.
`page`	query	integer	No	Page number. Default 1.

Request body

None.

Request payload

None.

Response body

The payload is inside data.

Field	Type	Description
`data`	array of objects	The activities on this page, newest first.
`data[].id`	integer	The activity's id.
`data[].description`	string	What happened, in words, e.g. `Acme Coffee - location edited`.
`data[].date`	string	When it happened (ISO 8601).
`data[].activity_type`	string	The kind of change: `partner_created`, `partner_deleted`, `brand_created`, `brand_updated`, `location_created`, `location_updated`, `location_deleted`, `user_added` or `user_deleted`. `brand` means an account.
`data[].entity_type`	string	What changed, e.g. `partner`, `brand` (an account), `location` or `user`.
`current_page`	integer	The current page.
`per_page`	integer	Activities per page.
`total`	integer	Total activities across all pages.

Response payload

{
  "data": {
    "data": [
      {
        "id": 6357,
        "description": "Jane Smith - user added",
        "date": "2026-09-28T09:42:03.000000Z",
        "activity_type": "user_added",
        "entity_type": "user"
      },
      {
        "id": 6207,
        "description": "Acme Coffee - location edited",
        "date": "2026-09-23T12:46:14.000000Z",
        "activity_type": "location_updated",
        "entity_type": "location"
      }
    ],
    "current_page": 1,
    "per_page": 10,
    "total": 2
  }
}

Examples

Success payload

See Response payload.

No activity yet:

{
  "data": {
    "data": [],
    "current_page": 1,
    "per_page": 10,
    "total": 0
  }
}

Error payload

422 limit above 100

{
  "message": "The limit field must not be greater than 100.",
  "errors": {
    "limit": [
      "The limit field must not be greater than 100."
    ]
  }
}

500 No account behind the token

{
  "message": "Internal Server Error",
  "status": "error",
  "errors": "Company not found"
}

429 Too many requests

{
  "message": "Too Many Attempts."
}

Status	Meaning
`200`	A page of activities.
`401`	The token is missing, expired or invalid.
`422`	`limit` is above 100.
`429`	More than 120 requests in a minute from this user.
`500`	The user behind the token has no company (`Company not found`), or an unexpected server error.

Example request

curl --request GET \
  --url "https://production-api.shoutaboutus.com/api/v1/partner/stats/activities?limit=10" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'

Updated 17 days ago

Did this page help you?