GET Company Activity

Retrieves the activity for a given company.

The most reliable method to ingest all activity from Rippling is to use a pagination cursor via the ‘next’ parameter. This will ensure that events are not skipped or duplicated due to the lack of timestamp precision.

The general sequence of steps to leverage the next parameter:

1. Issue an initial request using startDate with a value set to some date in the last 90 days
2. Retrieve the next page of events through the next value from the response data.
3. Issue the paginated request
4. Retrieve the next page of events through the next value from the response data
5. Pause and repeat the previous step

GET /platform/api/company_activity

GET Company Activity

cURL

curl --request GET \
  --url https://api.rippling.com/platform/api/company_activity \
  --header 'Authorization: Bearer <token>'

200

{
  "data": {
    "events": [
      {
        "id": "5ed7052182a6a429a4af3fb9",
        "request_data": null,
        "linked_events": [],
        "subjects": [
          {
            "instance": "5c6324b602bf9a760b7a4329",
            "type": "GROUP",
            "display_name": "Everyone",
            "icon": null
          },
          {
            "instance": "5c6324b502bf9a760b7a4318",
            "type": "SPOKE_USER",
            "display_name": "[e-mail]",
            "icon": null
          },
          {
            "instance": "5ca35d3b6ab9e20acc4e83e3",
            "type": "ROLE",
            "display_name": "Swag Test",
            "icon": null
          }
        ],
        "event_type": "EXTERNAL_GROUP_MEMBER_REMOVE",
        "timestamp": "2020-06-02T19:04:17.375000-07:00",
        "company": "595f75ffd2a5f80ae22ce88e",
        "spoke": "5c63187a3698be3692ce328f",
        "owner": "5c63232bc5929135ddadbfab",
        "initiator": {
          "type": "EXTERNAL",
          "role": null,
          "display_name": "External",
          "icon": null
        },
        "event_reason": {
          "reason": "CHANGE_SYNCED_FROM_EXTERNAL_APP",
          "message": "Activity emanated from External App"
        },
        "name": "Account removed from group"
      }
    ],
    "next": "5f4d9d82f6c26e0a83aa6ea8"
  },
  "error": null
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

startDate · string<date>

Timestamp to list activity after (inclusive). This should be less than 90 days from now. Defaults to 90 days.

endDate · string<date>

Timestamp to list activity before (inclusive).

next · string

Specifies the pagination cursor to the next page

limit · string

Specifies the number of results to page (maximum: 1000) (default: 1000)

Response

200 - application/json

OK

data · object

Show child attributes

error · string | null