Company activities

Returns a paginated list of emails and calendar meetings where any participant is associated with the company, ordered by date descending.

Filter parameters:

• type: email | meeting — omit to return both
• date_from: ISO date (YYYY-MM-DD), inclusive
• date_to: ISO date (YYYY-MM-DD), inclusive

Pagination:

• page: Page number (default: 1)
• per_page: Results per page (default: 50)

GET /v1/companies/{company_uuid}/activities

Get email and meeting activity history for a company.

cURL

curl --request GET \
  --url https://production-api.joinrings.com/v1/companies/{company_uuid}/activities \
  --header 'x-api-key: <api-key>'

import requests

url = "https://production-api.joinrings.com/v1/companies/{company_uuid}/activities"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://production-api.joinrings.com/v1/companies/{company_uuid}/activities', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://production-api.joinrings.com/v1/companies/{company_uuid}/activities",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://production-api.joinrings.com/v1/companies/{company_uuid}/activities"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://production-api.joinrings.com/v1/companies/{company_uuid}/activities")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://production-api.joinrings.com/v1/companies/{company_uuid}/activities")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "items": [
    {
      "activity_id": "<string>",
      "object_id": "<string>",
      "activity_timestamp": "<string>",
      "activity_type": "<string>",
      "body": "<string>",
      "cc_participants": [
        {
          "avatar_url": "<string>",
          "company_uuid": "<string>",
          "email": "<string>",
          "kind": "<string>",
          "name": "<string>",
          "person_uuid": "<string>",
          "status": "<string>"
        }
      ],
      "end_time": "<string>",
      "file_count": 123,
      "from_email": "<string>",
      "image_count": 123,
      "is_current_user_participant": true,
      "location": "<string>",
      "participants": [
        {
          "avatar_url": "<string>",
          "company_uuid": "<string>",
          "email": "<string>",
          "kind": "<string>",
          "name": "<string>",
          "person_uuid": "<string>",
          "status": "<string>"
        }
      ],
      "start_time": "<string>",
      "subject": "<string>",
      "title": "<string>"
    }
  ],
  "page": 123,
  "per_page": 123,
  "total": 123,
  "total_is_approximate": false
}

Authorizations

x-api-key · string · header · required

Path Parameters

company_uuid · string · required

Query Parameters

page · integer · default: 1

Page number, 1-indexed. Clamped to >= 1.

per_page · integer · default: 50

Results per page. Clamped to the range 1-100 (values outside are silently capped, not rejected).

type · enum<string> | null

Filter by activity type. 'email' or 'meeting'.

Available options: email, meeting

date_from · string | null

Filter activities on or after this ISO date (YYYY-MM-DD).

date_to · string | null

Filter activities on or before this ISO date (YYYY-MM-DD), inclusive.

Response

200 - application/json

Paginated activity history response.

items · ActivityHistoryItem · object[] · required

Show child attributes

page · integer · required

per_page · integer · required

total · integer · required

total_is_approximate · boolean · default: false