Get an address
Header Parameters
Query Parameters
Comma-separated allow-list of top-level fields to return, e.g. ?fields=id,name. Narrows the response only; it cannot widen it, and ?expand= does nothing on this API.
Comma-separated list of top-level fields to leave out, e.g. ?omit=children.
Path Parameters
Company ID. Must be one of the IDs returned by GET /api/v2/companies/.
Row id. A row belonging to another company is 404 on every verb, never 403.
Response
The row. Soft-deleted rows are returned here too, with deleted set.
Response Attributes
Label for the address, e.g. "Bag End".
Second address line.
Whether this is the company default address.
Setting this to true moves the flag: the previous holder is cleared and the call returns 200/201. Unsetting the last one is a 400.
Setting this to true moves the flag: the previous holder is cleared and the call returns 200/201. Unsetting the last one is a 400.
All six types are readable. Only company, billing, shipping and office can be written, see the write payload.
companybillingshippingpersonalofficemanualWhen the row was created.
When the row itself last changed.
null on a live row; the timestamp of the soft delete otherwise. Read-only everywhere.
Missing, invalid, or expired API key, or a session credential was used instead of an API key.
Response Attributes
validationErrorclientErrorserverError Show child attributes
Authenticated but not entitled: the key's user is not an active member of this company, the External API feature (or the resource's own feature) is not enabled for it, the key lacks the scope this verb needs, or a browser session was used.
Response Attributes
validationErrorclientErrorserverError Show child attributes
No such row for this company, including a row that belongs to another company, and a soft-deleted row you tried to write to. The API does not confirm whether the id exists elsewhere.
Response Attributes
validationErrorclientErrorserverError Show child attributes
Rate limit exceeded (60 requests per minute per API key). Retry after the number of seconds given in the message.
Response Attributes
validationErrorclientErrorserverError