Get an activity

GET

/activity/{activityId}

const url = 'https://apisandbox.puurk.com/activity/example';
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/activity/example \
  --header 'Authorization: Bearer <token>'

Returns a single activity event

Authorizations

service_token

Parameters

Path Parameters

activityId

required

string

ID of the activity

Responses

200

Successful operation

application/json

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>

Example

{
  "type": "offer_accepted",
  "category": "offer"
}

401

Unauthorized

404

Not found