List organization locations

GET

/organizations/{oid}/locations

const url = 'https://apisandbox.puurk.com/organizations/example/locations';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://apisandbox.puurk.com/organizations/example/locations \
  --header 'Authorization: Bearer <token>'

Returns every location of an organization. The one with is_primary true is the location onboarding reads for business_profile_complete and sales_tax_set.

Authorizations

service_token

Parameters

Path Parameters

oid

required

string

Organization ID

Responses

200

Successful operation

application/json

object

locations

Array<object>

A physical location of an organization. Onboarding reads the primary location: business_profile_complete needs ein, a logo and a location with is_primary true, and sales_tax_set needs sales_tax_rate on that location.

Every property is nullable — a location written before these endpoints existed may be missing any of them.

object

Unique identifier for the location

string

nullable

oid

Organization ID

string

nullable

eid

External identifier

string

nullable

name

string

nullable

address_line_1

string

nullable

address_line_2

string

nullable

city

string

nullable

state

Two-letter US state or territory code. Accepted in any case on a write and stored upper-cased — ca is read back as CA.

string

nullable

zip

12345 or 12345-6789

string

nullable

phone_number

string

nullable

email_address

string

nullable

is_primary

Exactly one location per organization is primary. The first location created is primary automatically.

boolean

nullable

sales_tax_rate

Decimal fraction between 0 and 1 — 0.0825 for 8.25%, not 8.25.

number format: double

nullable

photo_url

Set by Puurk; never accepted from a request body.

string

nullable

email_verified

Set by Puurk; never accepted from a request body.

boolean

nullable

Example

{
  "locations": [
    {
      "name": "Main Street",
      "address_line_1": "1 Main St",
      "address_line_2": "Suite 200",
      "city": "Austin",
      "state": "TX",
      "zip": "78701",
      "phone_number": "5125551234",
      "email_address": "main@example.com",
      "sales_tax_rate": 0.0825
    }
  ]
}

401

Unauthorized

403

forbidden — the token lacks the read action on organizations for this organization. Scope is checked before existence, so an unauthorized caller gets this rather than a 404.

application/json

The standard error body. error is a stable, machine-readable code — branch on it rather than on message, which is for humans and may change.

object

error

Machine-readable error code.

string

message

Human-readable detail.

string

Example

{
  "error": "merchant_account_missing",
  "message": "The organization has no merchant account. Complete Stripe Connect onboarding for this organization before generating pricing."
}

404

not_found — the organization does not exist.

application/json

The standard error body. error is a stable, machine-readable code — branch on it rather than on message, which is for humans and may change.

object

error

Machine-readable error code.

string

message

Human-readable detail.

string

Example

{
  "error": "merchant_account_missing",
  "message": "The organization has no merchant account. Complete Stripe Connect onboarding for this organization before generating pricing."
}