Returns addresses belonging to the specified firm and visible to the authenticated customer, paginated by opaque continuation token. Results are ordered by (modifiedDate ASC, id ASC).
Returns 404 if the firm does not exist or is not visible to the authenticated customer. A 403 is returned only when the caller’s token lacks the required scope; cross-customer access returns 404, not 403.
Opaque continuation token returned by the previous response’s page.nextToken. Omit on the first request. Format is server-controlled and may change without an API version bump.
Requested number of items in the response. Defaults to 25 when omitted; values outside [1, 250] are rejected with 400 (not clamped). The actual size returned is reflected in page.size and may be smaller (last page or empty result).
Default:25
>= 1<= 250
ID of the firm
A page of addresses belonging to the firm.
Page metadata for a token-based list response.
Operations for managing phone numbers
Returns a single phone by its identifier.
A 404 is returned when the phone does not exist or is not visible to the authenticated customer — the two cases are intentionally indistinguishable so that resource existence is never leaked across customers. A 403 is returned only when the access token is missing the required scope.
Phone identifier.
Example:550e8400-e29b-41d4-a716-446655440000
The requested phone.
A phone record returned by V2 phone endpoints.
Phone identifier.
Example:550e8400-e29b-41d4-a716-446655440000
The type of phone
Allowed values:CELLBUSINESSRESIDENTFAX
Example:CELL
10-digit phone number.
Example:3035551234
Optional phone extension.
Example:1234
Whether this is the preferred phone number.
Example:true
RFC3339 UTC timestamp when the phone was created.
Example:2024-01-15T10:30:00Z
RFC3339 UTC timestamp when the phone was last updated.
Example:2024-01-15T14:45:00Z
Updates a single phone by its identifier, scoped to the authenticated customer. Setting preferred: true unprefers all other phones for the owning person.
A 404 is returned when the phone does not exist or is not visible to the authenticated customer — the two cases are intentionally indistinguishable so that resource existence is never leaked across customers. A 403 is returned only when the access token is missing the required scope.
Phone identifier.
Example:550e8400-e29b-41d4-a716-446655440000
The type of phone
Allowed values:CELLBUSINESSRESIDENTFAX
Example:CELL
Phone number (exactly 10 digits)
Match pattern:^[0-9]{10}$
Example:3035551234
Optional phone extension (max 6 characters)
<= 6 characters
Example:1234
Whether this is the preferred phone number
Example:true
The updated phone.
A phone record returned by V2 phone endpoints.
Phone identifier.
Example:550e8400-e29b-41d4-a716-446655440000
The type of phone
Allowed values:CELLBUSINESSRESIDENTFAX
Example:CELL
10-digit phone number.
Example:3035551234
Optional phone extension.
Example:1234
Whether this is the preferred phone number.
Example:true
RFC3339 UTC timestamp when the phone was created.
Example:2024-01-15T10:30:00Z
RFC3339 UTC timestamp when the phone was last updated.
Example:2024-01-15T14:45:00Z
Permanently deletes a phone by ID, scoped to the authenticated customer. Returns 404 (never 403) when the phone does not exist or belongs to a different customer. The two cases are intentionally indistinguishable — the endpoint does not return an idempotent 204 for unknown IDs — so that resource existence is not leaked across customers.
Phone identifier.
Example:550e8400-e29b-41d4-a716-446655440000
Phone deleted successfully.