Retrieve organizations

Retrieves a list of organizations.

SecuritySecretApiKey or JWT
Request
query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

q
string

Use this field to perform a partial search of text fields.

Responses
200

List of organizations retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array
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 whether 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 whether 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

Desired time to go live.

object (OrganizationSettings)

Organization settings.

object

Tax calculation settings.

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.

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 (Self) non-empty

Related resource links.

Array (non-empty)
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/organizations
Request samples
Response samples
application/json
[
  • {
    }
]