Journal

Get list of journal entries for an event

get

An authenticated user retrieves the list of journal entries for the specified event

Path parameters
eventIdstring · uuidRequired
Query parameters
typestringOptional

Filter results by supported journal entry type

offsetintegerOptional

Pagination offset

limitinteger · min: 1 · max: 100Optional

Pagination limit

orderBystringOptional

Order the results by this field, in this direction

Example: createdAt:descPattern: ^[a-zA-Z0-9\_]+(:(asc|desc))?$
Responses
200
OK
application/json
get
GET /api/events/{eventId}/journal HTTP/1.1
Host: app.seedata.io
Accept: */*
200

OK

{
  "metadata": {
    "totalCount": 1,
    "offset": 1,
    "limit": 1
  },
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "creation",
      "message": "text",
      "priority": 1,
      "eventId": "123e4567-e89b-12d3-a456-426614174000",
      "createdByType": "text",
      "createdById": "text",
      "updatedAt": "2025-06-23T22:38:50.052Z",
      "createdAt": "2025-06-23T22:38:50.052Z"
    }
  ]
}

Create a review journal entry for an event

post

Create a single journal entry of type review

Path parameters
eventIdstring · uuidRequired
Body

Journal entries of a seed's event

idstring · uuidRead-onlyOptional
typestring · enumRead-onlyOptional

The type of the journal entry

Possible values:
messagestringRequired

A freeform message explaining why this status was chosen

prioritynumber · min: 1 · max: 5Required

The event priority

eventIdstring · uuidRead-onlyOptional

ID of the event this journal entry relates to

createdByTypestringRead-onlyOptional
createdByIdstringRead-onlyOptional
updatedAtstring · date-timeRead-onlyOptional
createdAtstring · date-timeRead-onlyOptional
Responses
201
Created
application/json
post
POST /api/events/{eventId}/journal HTTP/1.1
Host: app.seedata.io
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "message": "text",
  "priority": 1
}
201

Created

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "creation",
  "message": "text",
  "priority": 1,
  "eventId": "123e4567-e89b-12d3-a456-426614174000",
  "createdByType": "text",
  "createdById": "text",
  "updatedAt": "2025-06-23T22:38:50.052Z",
  "createdAt": "2025-06-23T22:38:50.052Z"
}

Get a journal entry for an event

get

An authenticated user retrieves a single journal entry for the specified event

Path parameters
eventIdstring · uuidRequired
journalIdstring · uuidRequired
Responses
200
OK
application/json
get
GET /api/events/{eventId}/journal/{journalId} HTTP/1.1
Host: app.seedata.io
Accept: */*
200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "creation",
  "message": "text",
  "priority": 1,
  "eventId": "123e4567-e89b-12d3-a456-426614174000",
  "createdByType": "text",
  "createdById": "text",
  "updatedAt": "2025-06-23T22:38:50.052Z",
  "createdAt": "2025-06-23T22:38:50.052Z"
}
PreviousAlertNextIntegrations

Was this helpful?