logo

Retrieve an organization

Retrieves an organization with a specified ID.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

Responses
200

Organization retrieved.

Response Schema: application/json
name
required
string <= 60 characters

Name of the organization.

country
required
string^[A-Z]{2}$

Country where the organization is located, in ISO Alpha-2 code format.

id
string <= 50 characters

Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.

address
string <= 60 characters

Street address of the organization.

address2
string <= 60 characters

Second line of the street address.

city
string <= 45 characters

City where the organization is located.

region
string <= 45 characters

Region or state where the organization is located.

postalCode
string <= 10 characters

Postal code of the organization.

Array of objects (ContactPhoneNumbers)

List of phone numbers associated with the contact.

Array
label
required
string <= 45 characters

Phone number label or name.

value
required
string <= 50 characters

Phone number value.

primary
boolean

Specifies if the phone number is the contact's primary phone number.

Array of objects (ContactEmails)

List of email addresses associated with the contact.

Array
label
required
string <= 45 characters

Email label or name.

value
required
string <email> <= 255 characters

Email address value.

primary
boolean

Specifies if the email address is the contact's primary email address.

taxDescriptor
string <= 255 characters

Tax label of the organization. This information is displayed on the invoice.

invoiceTimeZone
string <= 50 characters

Specifies the time zone to display on an invoice. UTC is used by default.

object (OrganizationQuestionnaire)

Organization questionnaire.

role
string

Role of the owner.

monthlyTransactions
string

Amount of monthly processed transaction.

products
Array of strings

List of products the organization is interested in.

integrationType
string

Type of integration the organization would like.

launchTiming
string

When the organization would like to go live.

object (OrganizationSettings)

Organization settings.

object

Tax calculation settings.

type
required
string

Type of tax calculator.

Enum: "taxjar" "avalara" "flat"
rate
number or null <float>

Rate for flat tax calculation.

object or null

Global organization settings for billing.

pendingOrderTtl
string or null
Default: null

Length of time, in ISO-8601 durations format, before which a pending order is automatically abandoned.

Array of objects (TaxLocation)

Additional organization addresses where a merchant may want to collect taxes using the taxjar tax calculator.

Available only for US-based organizations.

Array
country
required
string^[A-Z]{2}$

Country of the tax location, in ISO Alpha-2 code format.

address
string <= 60 characters

Street address of the tax location.

city
string <= 45 characters

City of the tax location.

region
string <= 45 characters

Region or state of the tax location.

postalCode
string <= 10 characters

Postal code of the tax location.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of objects (SelfLink)

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

get/organizations/{id}
Request samples 
$organization = $client->organizations()->load('organizationId');
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "name": "string",
  • "address": "string",
  • "address2": "string",
  • "city": "string",
  • "region": "string",
  • "country": "string",
  • "postalCode": "string",
  • "phoneNumbers": [
    ],
  • "emails": [
    ],
  • "taxDescriptor": "string",
  • "invoiceTimeZone": "America/New_York",
  • "questionnaire": {
    },
  • "settings": {
    },
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}
➔ Next to Update an organization