/
Retrieve organizations

Retrieve organizations

Request

Retrieves a list of organizations. If an organization requires multi-factor authentication (MFA) and your session has not passed MFA, the response includes only id, name, country, features, settings.security, and _links for that organization, and omits all other fields. In that case, only id, name, and features are available as filter fields, and only id and name are available as sort fields. To require MFA, use the Update security settings operation.

Security
SecretApiKey or JWT
Query
limitinteger, [ 0 .. 1000 ]

Limit the number of collection items to be returned. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total.

offsetinteger, [ 0 .. 1000 ]

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

filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

sortArray of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

qstring

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

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/organizations?limit=0&offset=0&filter=string&sort=string&q=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of organizations retrieved.

Headers
Pagination-Totalinteger

Total number of items that match the request. The value is independent of limit, including when limit is 0.

Example:332
Pagination-Limitinteger

Maximum number of items per page.

Example:100
Pagination-Offsetinteger

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
Bodyapplication/json
Array [
idstring, <= 50 charactersread-only

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

Example:"org_0YVDM8RC7GDADADSBSMW124JA8"
namestring, <= 60 charactersrequired

Name of the organization.

addressstring or null, <= 60 characters

Street address of the organization.

address2string or null, <= 60 characters

Second line of the street address.

citystring or null, <= 45 characters

City where the organization is located.

regionstring or null, <= 45 characters

Region or state where the organization is located.

countrystring or null^[A-Z]{2}$required

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

postalCodestring, <= 10 characters

Postal code of the organization.

phoneNumbersArray of objects(ContactPhoneNumbers)

List of phone numbers associated with the contact.

emailsArray of objects(ContactEmails)

List of email addresses associated with the contact.

taxDescriptorstring or null, <= 255 characters

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

invoiceTimeZonestring, <= 50 characters

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

Example:"America/New_York"
reportCurrencystring, = 3 characters(CurrencyCode)

Currency to use for conversion in reports. This value cannot be changed.

Example:"USD"
questionnaireobject or null

Organization questionnaire.

settingsobject

Organization settings.

taxNumbersArray of objects or null(TaxNumber)

Tax numbers of the organization.

featuresArray of objectsread-only

Organization features.

createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

]
Response
[
  {
    "id": "org_0YVDM8RC7GDADADSBSMW124JA8",
    "name": "string",
    "address": "string",
    "address2": "string",
    "city": "string",
    "region": "string",
    "country": "string",
    "postalCode": "string",
    "phoneNumbers": [ … ],
    "emails": [ … ],
    "taxDescriptor": "string",
    "invoiceTimeZone": "America/New_York",
    "reportCurrency": "USD",
    "questionnaire": { … },
    "settings": { … },
    "taxNumbers": [ … ],
    "features": [ … ],
    "createdTime": "2019-08-24T14:15:22Z",
    "updatedTime": "2019-08-24T14:15:22Z",
    "_links": [ … ]
  }
]