Journal | seedata.io DOCS

seedata.io DOCS

Get list of journal entries for an event

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

get

/events/{eventId}/journal

Path parameters

eventIdstring · uuidrequired

Query parameters

typestring

Filter results by supported journal entry type

offsetinteger

Pagination offset

limitinteger · min: 1 · max: 100

Pagination limit

orderBystring

Order the results by this field, in this direction

Example: createdAt:desc

Pattern: ^[a-zA-Z0-9\_]+(:(asc|desc))?$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://app.seedata.io/api/events/{eventId}/journal'

200

{
  "metadata": {
    "totalCount": 1,
    "offset": 1,
    "limit": 1
  },
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "message": "text",
      "priority": 1,
      "eventId": "123e4567-e89b-12d3-a456-426614174000",
      "createdByType": "text",
      "createdById": "text",
      "updatedAt": "2025-02-27T03:30:23.788Z",
      "createdAt": "2025-02-27T03:30:23.788Z",
      "type": "creation"
    }
  ]
}

Create a review journal entry for an event

Create a single journal entry of type review

post

/events/{eventId}/journal

Path parameters

eventIdstring · uuidrequired

Body

idstring · uuid

messagestringrequired

A freeform message explaining why this status was chosen

prioritynumber · min: 1 · max: 5required

The event priority

eventIdstring · uuid

ID of the event this journal entry relates to

createdByTypestring

createdByIdstring

updatedAtstring · date-time

createdAtstring · date-time

typestring · enum

The type of the journal entry

Options: creation, review, update

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://app.seedata.io/api/events/{eventId}/journal' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "message": "text",
    "priority": 1,
    "eventId": "123e4567-e89b-12d3-a456-426614174000",
    "createdByType": "text",
    "createdById": "text",
    "updatedAt": "2025-02-27T03:30:23.788Z",
    "createdAt": "2025-02-27T03:30:23.788Z",
    "type": "creation"
  }'

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "message": "text",
  "priority": 1,
  "eventId": "123e4567-e89b-12d3-a456-426614174000",
  "createdByType": "text",
  "createdById": "text",
  "updatedAt": "2025-02-27T03:30:23.788Z",
  "createdAt": "2025-02-27T03:30:23.788Z",
  "type": "creation"
}

Created

Get a journal entry for an event

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

get

/events/{eventId}/journal/{journalId}

Path parameters

eventIdstring · uuidrequired

journalIdstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://app.seedata.io/api/events/{eventId}/journal/{journalId}'

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "message": "text",
  "priority": 1,
  "eventId": "123e4567-e89b-12d3-a456-426614174000",
  "createdByType": "text",
  "createdById": "text",
  "updatedAt": "2025-02-27T03:30:23.788Z",
  "createdAt": "2025-02-27T03:30:23.788Z",
  "type": "creation"
}