Address

An Address represents a physical location owned by either a person or an organization. Each address stores full geographic details including coordinates. A single address can be designated as the primary address for its owner, which updates the owner’s primary_address_id pointer.

Sample Object

{
  "id": "adr_xyz789uvw012",
  "owner_id": "ppl_abc123def456",
  "label": "Home",
  "continent": "North America",
  "country": "US",
  "state": "California",
  "city": "San Francisco",
  "region": "Bay Area",
  "zipcode": "94105",
  "address": "Market Street",
  "address_number": "123",
  "longitude": -122.39,
  "latitude": 37.79
}

Fields

Field	Type	Description
`id`	`string`	Unique identifier for the address. Auto-generated on create.
`owner_id`	`string`	ID of the person or organization that owns this address.
`label`	`string`	Friendly name for the address such as Home, Office, or HQ.
`continent`	`string`	Continent name.
`country`	`string`	Country code or name.
`state`	`string`	State, province, or region.
`city`	`string`	City name.
`region`	`string`	Local administrative area or district.
`zipcode`	`string`	Postal or ZIP code.
`address`	`string`	Street name.
`address_number`	`string`	Building or street number.
`longitude`	`float`	Geographic longitude coordinate.
`latitude`	`float`	Geographic latitude coordinate.
`primary`	`boolean`	When set to `true` on create or update, this address becomes the owner’s primary address.

Actions

Person

Adding an address

Adds a new address to a person’s address collection. When the primary flag is set to true, the owner’s primary_address_id is updated to point to this address.

obx app identity:people:addresses init
obx app identity:people:addresses push init --person-id ppl_abc123def456

const address = await oblax.identity.address.create("ppl_abc123def456", {
  label: "Home",
  country: "US",
  city: "San Francisco",
  zipcode: "94105",
  address: "Market Street",
  address_number: "123",
  longitude: -122.39,
  latitude: 37.79,
  primary: true,
});

POST /api/v1/identity/people/ppl_abc123def456/addresses

{
  "label": "Home",
  "country": "US",
  "city": "San Francisco",
  "zipcode": "94105",
  "address": "Market Street",
  "address_number": "123",
  "longitude": -122.39,
  "latitude": 37.79,
  "primary": true
}

Successful response

{
  "id": "adr_xyz789uvw012",
  "owner_id": "ppl_abc123def456",
  "label": "Home",
  "country": "US",
  "city": "San Francisco",
  "zipcode": "94105",
  "address": "Market Street",
  "address_number": "123",
  "longitude": -122.39,
  "latitude": 37.79
}

Listing all addresses

Returns all addresses owned by a specific person.

obx app identity:people:addresses list --person-id ppl_abc123def456

GET /api/v1/identity/people/ppl_abc123def456/addresses

Successful response

[
  {
    "id": "adr_xyz789uvw012",
    "owner_id": "ppl_abc123def456",
    "label": "Home",
    "country": "US",
    "city": "San Francisco",
    "zipcode": "94105",
    "address": "Market Street",
    "address_number": "123",
    "longitude": -122.39,
    "latitude": 37.79
  }
]

Getting an address

Returns a specific address by its ID within the context of the person owner.

obx app identity:people:addresses pull adr_xyz789uvw012 --person-id ppl_abc123def456

GET /api/v1/identity/people/ppl_abc123def456/addresses/adr_xyz789uvw012

Successful response

{
  "id": "adr_xyz789uvw012",
  "owner_id": "ppl_abc123def456",
  "label": "Home",
  "country": "US",
  "city": "San Francisco",
  "zipcode": "94105",
  "address": "Market Street",
  "address_number": "123",
  "longitude": -122.39,
  "latitude": 37.79
}

Updating an address

Updates the fields of an address. Set primary to true to promote this address as the owner’s primary.

obx app identity:people:addresses push adr_xyz789uvw012 --person-id ppl_abc123def456

Deleting an address

Removes an address from the person. If the deleted address was the primary address, the owner’s primary_address_id is set to null.

obx app identity:people:addresses delete adr_xyz789uvw012 --person-id ppl_abc123def456

Deleting all addresses

Removes every address owned by the person in a single operation.

obx app identity:people:addresses delete-all --person-id ppl_abc123def456

Organization

Adding an address

Adds a new address to an organization’s address collection. When the primary flag is set to true, the organization’s primary_address_id is updated.

obx app identity:organizations:addresses init
obx app identity:organizations:addresses push init --org-id org_abc123def456

const address = await oblax.identity.address.create("org_abc123def456", {
  label: "HQ",
  country: "US",
  city: "San Francisco",
  zipcode: "94105",
  address: "Market Street",
  address_number: "456",
  longitude: -122.4,
  latitude: 37.78,
});

POST /api/v1/identity/organizations/org_abc123def456/addresses

{
  "label": "HQ",
  "country": "US",
  "city": "San Francisco",
  "zipcode": "94105",
  "address": "Market Street",
  "address_number": "456",
  "longitude": -122.40,
  "latitude": 37.78
}

Successful response

{
  "id": "adr_xyz789uvw012",
  "owner_id": "org_abc123def456",
  "label": "HQ",
  "country": "US",
  "city": "San Francisco",
  "zipcode": "94105",
  "address": "Market Street",
  "address_number": "456",
  "longitude": -122.4,
  "latitude": 37.78
}

Listing all addresses

Returns all addresses owned by a specific organization.

obx app identity:organizations:addresses list --org-id org_abc123def456

GET /api/v1/identity/organizations/org_abc123def456/addresses

Successful response

[
  {
    "id": "adr_xyz789uvw012",
    "owner_id": "org_abc123def456",
    "label": "HQ",
    "country": "US",
    "city": "San Francisco",
    "zipcode": "94105",
    "address": "Market Street",
    "address_number": "456",
    "longitude": -122.4,
    "latitude": 37.78
  }
]

Getting an address

Returns a specific address by its ID within the context of the organization owner.

obx app identity:organizations:addresses pull adr_xyz789uvw012 --org-id org_abc123def456

GET /api/v1/identity/organizations/org_abc123def456/addresses/adr_xyz789uvw012

Successful response

{
  "id": "adr_xyz789uvw012",
  "owner_id": "org_abc123def456",
  "label": "HQ",
  "country": "US",
  "city": "San Francisco",
  "zipcode": "94105",
  "address": "Market Street",
  "address_number": "456",
  "longitude": -122.4,
  "latitude": 37.78
}

Updating an address

Updates the fields of an address. Set primary to true to promote this address as the organization’s primary.

obx app identity:organizations:addresses push adr_xyz789uvw012 --org-id org_abc123def456

Deleting an address

Removes an address from the organization. If the deleted address was the primary address, the organization’s primary_address_id is set to null.

obx app identity:organizations:addresses delete adr_xyz789uvw012 --org-id org_abc123def456

Deleting all addresses

Removes every address owned by the organization in a single operation.

obx app identity:organizations:addresses delete-all --org-id org_abc123def456

Organization Contact Method