Skip to content
Patrimoine
v9.1.0

Get Institution Endpoint

GET
/api/v1/institutions/{institution_id}
curl --request GET \
  --url https://example.com/api/v1/institutions/1

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
institution_id
required
Institution Id
integer

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
InstitutionOut
object
id
required
Id
integer
user_id
required
User Id
integer
name
required
Name
string
color
required
Any of:
string
sort_order
required
Sort Order
integer
is_default
required
Is Default
boolean
archived_at
required
Any of:
string format: date-time
deleted_at
required
Any of:
string format: date-time
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time

Example generated

{
  "id": 1,
  "user_id": 1,
  "name": "example",
  "color": "example",
  "sort_order": 1,
  "is_default": true,
  "archived_at": "2026-04-15T12:00:00Z",
  "deleted_at": "2026-04-15T12:00:00Z",
  "created_at": "2026-04-15T12:00:00Z",
  "updated_at": "2026-04-15T12:00:00Z"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object

Example generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}