Skip to main content

This page is also available as plain markdown · OpenAPI spec

Get activity

GET 

/activities/:id

Get activity

Request

Path Parameters

    idstringrequired
    Example: 00000000-0000-0000-0000-000000000000

200

Returns the activity
objectstringrequired
idstringrequired
messagestringrequired
activityTypestringrequired
createdAtstringrequired
updatedAtstringrequired
actorIdstringrequired
actorTypestringrequired
ownerIdstringrequired
targetIdstringrequired
targetTypestringrequired
metaobjectrequired
requestIdstringrequired
Example: returns_the_activity
{
  "object": "activity",
  "id": "b370fcac-c2d8-4f66-961d-84774e3d76de",
  "message": "Registered for event",
  "activityType": "event_registration_paid_created",
  "createdAt": "2024-01-02T03:04:05+01:00",
  "updatedAt": "2024-01-02T03:04:05+01:00",
  "actorId": "809b7cc4-1921-4c44-8523-a025769e5603",
  "actorType": "user",
  "ownerId": "cb51f9b0-f181-4683-82a1-62a558fa7c55",
  "targetId": "d7971452-a59e-4ec3-a0fa-5e1bb0aae340",
  "targetType": "Course",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}

401

Returns 401
objectstringrequired
statusintegerrequired
messagestringrequired
metaobjectrequired
requestIdstringrequired
Example: returns_401
{
  "object": "error",
  "status": 401,
  "message": "Authentication required",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}

404

Returns 404 for non-existent activity
objectstringrequired
statusintegerrequired
messagestringrequired
metaobjectrequired
requestIdstringrequired
Example: returns_404_for_non-existent_activity
{
  "object": "error",
  "status": 404,
  "message": "Resource not found",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}