Skip to main content
GET
Get Organization Address

Authorizations

Authorization
string
header
required

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

Query Parameters

fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

OK

Organization address

organizationAddressId
string<uuid>
required

Address identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

organizationId
string<uuid>
required

Organization identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

country
any
required

Country

Example:

"BR"

state
any
required

State

Example:

"SP"

city
string
required

City

Example:

"São Paulo"

zipCode
any
required

Zip code

Example:

"01310-100"

street
string
required

Street

Example:

"Av. Paulista"

neighborhood
string
required

Neighborhood

Example:

"Bela Vista"

number
string
required

Number

Example:

"1000"

createdAt
string<date-time>
required

Created at

Example:

"2026-01-01T00:00:00.000Z"

updatedAt
string<date-time>
required

Updated at

Example:

"2026-01-01T00:00:00.000Z"

complement
string | null

Complement

Example:

"Sala 42"

createdBy
string<uuid> | null

Created by

Example:

null

updatedBy
string<uuid> | null

Updated by

Example:

null

deletedBy
string<uuid> | null

Deleted by

Example:

null

deletedAt
string<date-time> | null

Deleted at

Example:

null