Skip to main content
GET
Get a unit (parent or child) by id (BO)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Query Parameters

extend
enum<string>[]

Extend options (JSON-encoded array, e.g. ?extend=["category"]):

  • "actions-info": Projects { canBeUpdated, canBeDeleted, canBeArchived, canBeUnarchived }.
  • "updatable-fields": Per-field write rules for this unit in its current state.
  • "parent": Parent unit summary (null on a parent unit).
  • "nb-children": Number of non-deleted children (always 0 on a child unit) and QR codes.
  • "organization": The unit's organization (id, name, type, accessStatus).
  • "created-by": The BO admin who created this unit.
  • "logo-url": Presigned download URL for the unit logo (null when no logo).
Available options:
actions-info,
updatable-fields,
parent,
nb-children,
organization,
created-by,
logo-url

Response

Default Response

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
ref
string
required
Maximum string length: 40
Pattern: ^[A-Z]+-[1-9]\d*(?:-[A-Z]+-[1-9]\d*)*$
type
enum<string>
required
Available options:
parent,
child
name
string
required
Required string length: 1 - 150
description
string | null
required
Maximum string length: 1000
serialNumber
string | null
required
Required string length: 1 - 20
openedAt
string<date-time> | null
required
logo
object | null
required
activityTypes
enum<string>[]
required
Available options:
J,
L,
M,
N,
O,
P,
R,
S,
T,
U,
V,
W,
X,
Y,
PA,
CTS,
SG,
OA,
REF,
PS,
GHA,
GHO,
GHR,
GHS,
GHTC,
GHU,
GHW1,
GHW2,
GHZ,
ITGH
classifications
enum<string>[]
required
Available options:
erp,
ert,
igh,
icpe,
hab,
other
totalSurfaceArea
integer | null
required
Required range: 0 < x <= 9007199254740991
publicCapacity
integer | null
required
Required range: 0 <= x <= 9007199254740991
privateCapacity
integer | null
required
Required range: 0 <= x <= 9007199254740991
pinCode
string
required
Pattern: ^\d{6}$
pinCodeRequired
boolean
required
accessInstructions
string | null
required
Maximum string length: 1000
leafletDispatchedAt
string<date-time> | null
required
onboardingStatus
enum<string> | null
required
Available options:
pending,
in_progress,
on_hold,
completed
organizationId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
createdByBoUserId
string<uuid> | null
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
addressCountry
string | null
required
Required string length: 1 - 200
addressCity
string | null
required
Required string length: 1 - 200
addressPostalCode
string | null
required
Required string length: 1 - 20
addressStreet
string | null
required
Required string length: 1 - 200
category
enum<string> | null
required
Available options:
1,
2,
3,
4,
5
commissionPeriodicityYears
required
Available options:
3
parentId
string<uuid> | null
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
sortOrder
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
archivedAt
string<date-time> | null
required
deletedAt
string<date-time> | null
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
actions
object
updatableFields
object
parent
object | null
nbChildren
integer
Required range: 0 <= x <= 9007199254740991
nbQrCodes
integer
Required range: 0 <= x <= 9007199254740991
organization
object
createdBy
object | null
logoUrl
string<uri> | null