Returns addresses belonging to the specified person and visible to the authenticated customer, paginated by opaque continuation token. Results are ordered by (modifiedDate ASC, id ASC).
Returns 404 if the person 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 person
A page of addresses belonging to the person.
Page metadata for a token-based list response.
Creates a new address and associates it with the specified firm under the authenticated customer’s scope.
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. Returns 400 when the request body fails validation (V2 error shape).
ID of the firm
Client-generated UUID used to deduplicate retried requests. When provided, the server caches the first successful response for this key and returns it for any subsequent request with the same key from the same client, without re-processing.
Type of address
Allowed values:MAILINGBUSINESSPHYSICAL
First line of the street address.
Example:123 Main St
Second line of the street address (suite, unit, etc.).
Example:Apt 4B
City.
Example:Denver
Two-letter US state code.
>= 2 characters<= 2 characters
Example:CO
ZIP code in 5-digit or ZIP+4 format.
Match pattern:^\d{5}(-\d{4})?$
Example:80202
County name.
Example:Denver
Country code (ISO alpha-2).
>= 2 characters<= 2 characters
Example:US
Date the person moved to this address (YYYY-MM-DD).
Example:2020-01-15
Whether this should be the person’s preferred address. When the person has no existing addresses, the server sets this to true regardless of the supplied value.
Default:false
Example:false
Address created successfully.
Address identifier.
Example:550e8400-e29b-41d4-a716-446655440000
Type of address
Allowed values:MAILINGBUSINESSPHYSICAL
First line of the street address.
Example:123 Main St
Second line of the street address (suite, unit, etc.).
Example:Apt 4B
City.
Example:Denver
Two-letter US state code.
>= 2 characters<= 2 characters
Example:CO
ZIP code in 5-digit or ZIP+4 format.
Match pattern:^\d{5}(-\d{4})?$
Example:80202
County name.
Example:Denver
Country code (ISO alpha-2).
>= 2 characters<= 2 characters
Example:US
Date the person moved to this address (YYYY-MM-DD).
Example:2020-01-15
Whether this is the person’s preferred address.
Example:true
RFC3339 UTC timestamp when the address was created.
Example:2024-01-15T10:30:00Z
RFC3339 UTC timestamp when the address was last updated.
Example:2024-01-15T14:45:00Z
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