Get one permit

GET

/{organizationNickname}/projects/{projectId}/permits/{permitId}

curl --request GET \
  --url https://app.civillo.com/api/v1/example/projects/1/permits/1 \
  --header 'Authorization: Bearer <token>'

• Civillo API

Returns a detailed view of a specific permit.

Authorizations

• bearerAuth
  User

Parameters

Path Parameters

organizationNickname

required

string

projectId

required

integer

permitId

required

integer

Responses

200

Detailed permit object

Media typeapplication/json

object

declaration

string

nullable

legendLayersOnly

boolean

categories

Array<object>

object

id

integer

name

string

status

integer

signoffs

Array<string>

signatures

Array<object>

object

timestamp

string format: date-time

nullable

userId

string

isRejection

boolean

comment

string

nullable

groupId

string

nullable

imageUrl

string

nullable

signatureRequirements

Array<object>

object

userId

string

groupId

string

nullable

minGroupMembersRequired

integer

nullable

creator

object

role

integer

user

object

id

string

firstName

string

lastName

string

username

string

id

integer

uuid

string format: uuid

name

string

template

object

id

integer

name

string

description

string

nullable

status

integer

description

string

nullable

startTime

string format: date-time

expiryDate

string format: date-time

renewalTime

string format: date-time

nullable

timesRenewed

integer

maxRenewals

integer

nullable

renewalsRemaining

integer

nullable

requesterId

string format: uuid

nullable

holderId

string format: uuid

nullable

specifiedHolderId

string format: uuid

nullable

geometry

string

documentUrl

string format: uri

civilloUrl

string format: uri

archived

boolean

holdable

boolean

cancellable

boolean

allowCopy

boolean

copiedFrom

string format: uuid

nullable

daysValid

number format: float

validTime

The renewal period in whole hours, rounded down. Null if the permit never requires renewal.

integer

nullable

validTimeMinutes

The exact renewal period in minutes. Omitted if the permit never requires renewal.

integer

nullable

lapsed

boolean

Example^generated

{
  "id": 1,
  "uuid": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "name": "example",
  "template": {
    "id": 1,
    "name": "example",
    "description": "example"
  },
  "status": 1,
  "description": "example",
  "startTime": "2026-04-15T12:00:00Z",
  "expiryDate": "2026-04-15T12:00:00Z",
  "renewalTime": "2026-04-15T12:00:00Z",
  "timesRenewed": 1,
  "maxRenewals": 1,
  "renewalsRemaining": 1,
  "requesterId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "holderId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "specifiedHolderId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "geometry": "example",
  "documentUrl": "https://example.com",
  "civilloUrl": "https://example.com",
  "archived": true,
  "holdable": true,
  "cancellable": true,
  "allowCopy": true,
  "copiedFrom": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "daysValid": 1,
  "validTime": 1,
  "validTimeMinutes": 1,
  "lapsed": true
}

401

Unauthorized

404

Permit not found