Skip to content

Select theme

Get permit events

GET
/{organizationNickname}/projects/{projectId}/permits/{permitId}/events
curl --request GET \
--url 'https://app.civillo.com/api/v1/example/projects/1/permits/1/events?pageSize=50&pageNumber=1' \
--header 'Authorization: Bearer <token>'

Returns a paginated list of events associated with a permit.

organizationNickname
required
string
projectId
required
integer
permitId
required
integer
pageSize
integer
default: 50
pageNumber
integer
default: 1

A paginated list of permit events.

Media typeapplication/json
object
pageNumber
integer
pageSize
integer
totalCount
integer
totalPages
integer
items
Array<object>
object
permitId
required
integer
type
required

PermitEventDiscriminator enum value

integer
typeLabel

Human-readable label for the event type

string
timestamp
required
string format: date-time
description
required
string
comment
string
nullable
groupId
integer
nullable
user
string format: uuid
nullable
permitStatus

Included when type is StatusUpdate (0)

integer
nullable
permitCategoryStatus

Included when type is CategoryStatusUpdate (1)

integer
nullable
statusLabel

Included for (category) status update events (0, 1). Human-readable label for the status.

string
nullable
categoryInstanceId

Included for category-related events (1, 4, 8, 10, 11)

integer
nullable
categoryName

Included for category-related events (1, 4, 8, 10, 11)

string
nullable
fileName

Included for attachment events (2, 9)

string
nullable
Examplegenerated
{
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1,
"totalPages": 1,
"items": [
{
"permitId": 1,
"type": 1,
"typeLabel": "example",
"timestamp": "2026-04-15T12:00:00Z",
"description": "example",
"comment": "example",
"groupId": 1,
"user": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"permitStatus": 1,
"permitCategoryStatus": 1,
"statusLabel": "example",
"categoryInstanceId": 1,
"categoryName": "example",
"fileName": "example"
}
]
}

Unauthorized

Permit not found