List activity for a client

GET

/organizations/{oid}/clients/{clientId}/activity

const url = 'https://apisandbox.puurk.com/organizations/example/clients/example/activity';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://apisandbox.puurk.com/organizations/example/clients/example/activity \
  --header 'Authorization: Bearer <token>'

Returns a paginated activity timeline for a client within an organization

Authorizations

service_token

Parameters

Path Parameters

oid

required

string

Organization ID

clientId

required

string

Client (lead) ID

Query Parameters

cursor

string

Pagination cursor

limit

integer

Number of results to return

Responses

200

Successful operation

application/json

object

data

Array<object>

object

string

oid

Organization ID

string

eid

Employee/entity ID

string

client_id

Client (lead) ID

string

location_id

string

type

Type of activity notification

string

Allowed values: offer_accepted offer_declined offer_paid_in_full offer_shared offer_viewed contract_signed contract_fulfilled contract_cancelled payment_succeeded payment_declined payment_refunded payment_returned payment_reminder payout_initiated

category

string

Allowed values: offer contract payment payout

reference_id

ID of the referenced entity (offer, contract, payment, etc.)

string

timestamp

string format: date-time

uid

string

title

string

description

string

metadata

object

key

additional properties

any

related_uids

Array<string>

pagination

object

limit

Page size used for this response

integer

hasMore

Whether more results are available

boolean

nextCursor

Cursor for the next page, null when no more results

string

nullable

Example

{
  "data": [
    {
      "type": "offer_accepted",
      "category": "offer"
    }
  ]
}

401

Unauthorized