BETA: Please note that the current endpoints are considered beta. It is possible there may be changes before these endpoints are finalised.

Organizations

Get an Organization

Get organization token is authorized for

get /organizations/{organizationId}

Parameters

NameTypeInDescription
organizationIdstringpathOrganization ID

Responses

200: OK response.Organization
{
  "createdAt": "2012-08-08T02:35:21Z",
  "currency": "AUD",
  "id": "ORG001",
  "name": "My Awesome Business",
  "timezone": "Australia/Melbourne"
}
404: Not Found response.

List Organizations

List all organizations based on a token

get /organizations

Parameters

NameTypeInDescription
afterstringquery
querystringquery

Responses

200: OK response.Organization[]
[
  {
    "createdAt": "2012-08-08T02:35:21Z",
    "currency": "AUD",
    "id": "ORG001",
    "name": "My Awesome Business",
    "timezone": "Australia/Melbourne"
  },
  {
    "createdAt": "2012-08-08T02:35:21Z",
    "currency": "AUD",
    "id": "ORG001",
    "name": "My Awesome Business",
    "timezone": "Australia/Melbourne"
  }
]

Models

Organization

NameTypeDescription
idstring Unique organization ID
namestring Display name of the organization
createdAtstring Timestamp this org was created
currencystring(enum)(optional) The currency used for purchases for this organization
"AUD", "SGD", "GBP", "NZD"
timezonestring(optional) Timezone this organization is in

OrganizationTiny

NameTypeDescription
idstring Unique organization ID
namestring Display name of the organization

In this article