Get customer tenants

Returns a list of end customers for a organization. A customer tenant is connected to a publisher.

Prerequisites

  • Credentials as described in Authentication
  • An organization identifier

C#

To get customer tenants, first instantiate CustomerTenantFilter and set OrganizationId property with your organization id. Then set Page and PageSize properties to their respective value if you would like to restrict number of objects in the result. Page and PageSize properties are used to apply paging in the result.

Next, get the instance of CrayonApiClient and then get the client token using the instance. This client token will be passed when retrieving the customer tenant.

Finally, call CustomerTenants.Get() method to get all customer tenants based on the organization id by passing the token and the instance of CustomerTenantFilter.

var filter = new CustomerTenantFilter
{
        OrganizationId = 1,
        Page = 1,
        PageSize = 5,
        DomainPrefix = "mycustomer",
        PublisherId = 1,
        CustomerTenantType = CustomerTenantType.T1
};

var client = new CrayonApiClient("https://api.crayon.com/");
var token = client.Tokens.GetUserToken(clientId, clientSecret, userName, password).GetData().AccessToken;
var result = client.CustomerTenants.Get(token, filter);

Request

Request Syntax:

Method Request URI
GET https://api.crayon.com/api/v1/customertenants/?organizationId={organizationId}&search={search}&page={page}&pageSize={pageSize}

Request Parameters:

Name Type Required Description
organizationId int Yes Identifier for organization
search string No Search by customer tenant name, and reference
page int No Pagination, starts at page 1
pageSize int No Pagination, Number of objects to return
domainPrefix string No Domain name used for urls, subscriptions and usernames
publisherId int No Internal identifier the publisher uses
customerTenantType CustomerTenantType No T1 = 1, T2 = 2

Request Headers:

The following HTTP request headers are supported

Header Type Description
Authorization string Required. The authorization token in the form Bearer <token>.
Accept string Specifies the request and response type, “application/json”.
Content-Type string Specifies the media type of the resource, “application/json”.

Request Example:

GET $"/api/v1/customertenants/?organizationId={organizationId}&search={search}&page={page}&pageSize={pageSize}
Accept : application/json
Content-Type: application/json
Authorization : Bearer < Token >

Response

If successful, this method returns a CustomerTenantCollection resource in the response body.

Response Body:

{
  "Items": [
    {
      "Id": 32,
      "Name": "My Customer AB",
      "Publisher": {
        "Id": 2,
        "Name": "Microsoft"
      },
      "PublisherCustomerId": "y73ce2e6-d573-4fbe-966c-c5155015cce5",
      "ExternalPublisherCustomerId": "f1f80c1e-498d-4c4e-b54c-55095479c8e3",
      "DomainPrefix": "mycustomer",
      "Reference": "",
      "CustomerTenantType": 2,
      "Organization": {
        "Id": 4703,
        "Name": "My company AB",
        "Tenant": {
          "Id": 1,
          "Name": "My company AB"
        }
      },
      "InvoiceProfile": {
        "Id": 57,
        "Name": "Invoice profile"
      }
    },
    {     
      "Id": 32,
      "Name": "My end customer 2",
      "Publisher": {
        "Id": 3,
        "Name": "Publisher 2"
      },
      "PublisherCustomerId": "c93ce2e7-d573-4fbe-966c-c5155015cce5",
      "ExternalPublisherCustomerId": "f1f80c1e-498d-4c4e-b54c-55095479c8e3",
      "DomainPrefix": "mycustomer2",
      "Reference": "",
      "CustomerTenantType": 2,
      "Organization": {
        "Id": 4343,
        "Name": "My company AB 2",
        "Tenant": {
          "Id": 2,
          "Name": "My company AB 2"
        }
      },
      "InvoiceProfile": {
        "Id": 7,
        "Name": "My Invoice profile"
      }   
    }
  ],
  "TotalHits": 2
}

Response success and error codes:

Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use a network trace tool to read this code, error type, and additional parameters.

Error Codes Description
200 Ok The request has succeeded.
400 Bad Request The request could not be understood by the server due to malformed syntax, missing required properties, properties that couldn’t be parsed according to their type (and length). It is a non-retryable error condition. The client should not repeat the request without modifications.
401 Unauthorized The request requires user authentication. If the request already included Authorization credentials, then the 401 (Unauthorized) status code means that authorization has been refused for those credentials. It is a non-retryable error condition.