Get a List of Tenants

URL: https://api.courier.com/tenants

Method: GET

Path Parameters:

None

Query Parameters

limitnumber

The number of accounts to return (defaults to 20, maximum value of 100)

starting_afterstring

Value of next_page from previous response

Response Body:

itemsTenant

An array of Tenants

+ Show Tenant properties

has_moreboolean

Set to true when there are more pages that can be retrieved.

urlstring

A url that may be used to generate these results.

next_urlstring?

A url that may be used to generate fetch the next set of results. Defined only whenhas_more is set to true

cursorstring?

A pointer to the next page of results. Defined only whenhas_more is set to true

type"list"

Always set to "list". Represents the type of this object.

Example:

GET https://api.courier.com/tenants

RESPONSE BODY
{
  items: [
    {
      id: "ACME",
      name: "ACME Inc",
      properties: {
        ceo: "Person",
      },
      default_preferences: {
        items: [{
          id: "RBV0C2C7ZMM20EJQ59Q7K4ES6VK0",
          status: "OPTED_IN",
          type: "subscription_topic"
        }]
      },
      user_profile: {
        locale: "en-US",
        "slack": {
          "access_token": "xoxb-bunch-o-letters",
        }
      }
    }
  ],
  has_more: false
}