List all customers

GET /v1/Customers

Returns a list of your customers. The customers are returned sorted by the specified sortPropertyName. Available to the roles: csp, reseller

Headers

  • X-Tenant string Required

    The domain used to access the portal.

  • Authorization string Required

    JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

    Default value is Bearer eyJ0eXAiO....

  • X-Correlation-Id string(UUID)

    This header is optional and by setting it you can correlate the audit logs made by this request.

Query parameters

  • pageNumber integer(int32)

    A cursor for pagination across multiple pages of results. The default value is 1.

  • pageSize integer(int32)

    The number of objects to be returned at each page. The size can range between 1 and 2000, and the default is 25.

  • searchValue string

    The search query string. Required if searchField is provided. The search value has a maximum of 255 characters.

  • searchField string

    The field in which the search is performed. Possible values: Company.Name; Domain; InternalIdentifier and ProviderCustomerId. If searchValue was set but searchField wasn't then by default the search will be done by Company.Name.

  • sortPropertyName string

    The name of the property to sort the customers by. Possible values: Company.Name

  • ascendingOrder boolean

    if set to true [ascending order].

  • resellerId string(uuid)

    The reseller identifier. View only the customers that have relation with the specified resellerId.

  • showDeleted boolean

    If true the deleted customers will be included.

    Default value is true.

Responses

  • 200

    OK

    Hide response attributes Show response attributes object
    • items array[object] | null

      The items for this page.

      View model that represents a customer.

      Hide items attributes Show items attributes object
      • id string(uuid)

        The GUID identifier for the customer.

      • companyName string | null Required

        The name of the company. This may be up to 255 characters.

      • taxId string | null

        The company tax Id. This may be up to 255 characters.

      • country string | null Required

        The company country code in the ISO 3166-1 alpha-2 standard.

      • addressLine1 string | null Required

        The company address line 1. This may be up to 255 characters.

      • addressLine2 string | null

        The company address line 2. This may be up to 255 characters.

      • city string | null Required

        The company city. This may be up to 255 characters.

      • state string | null Required

        The company State. This may be up to 255 characters.

      • zip string | null Required

        The company ZIP. This may be up to 30 characters.

      • firstName string | null Required

        The company primary contact first name. This may be up to 255 characters.

      • middleName string | null

        The company primary contact middle name. This may be up to 255 characters.

      • lastName string | null Required

        The company primary contact last name. This may be up to 255 characters.

      • email string | null Required

        The company primary contact email. This may be up to 255 characters.

      • phone string | null Required

        The company primary contact phone. This may be up to 30 characters.

      • internalIdentifier string | null

        The customer internal identifier. This may be up to 255 characters.

      • resellerId string(uuid) | null

        The reseller identifier. If this value is set a relation between this customer and the reseller will be created, if null a direct relation between the CSP and the customer will be created instead.

      • providerCustomers object | null Required

        The provider customers. A list containing the info about this customer in one or more provider instances.

        Hide providerCustomers attribute Show providerCustomers attribute object | null
        • * object Additional properties

          Additional properties are NOT allowed.

          Hide * attributes Show * attributes object
          • providerInstanceId string(uuid) Required

            The GUID identifier for the provider instance.

          • providerCustomerId string | null

            The identifier for customer on the provider. This property will only be populated after a customer is successfully created on the provider.

          • providerCustomerData string | null Required

            The provider specific data for this customer.

          • margin object Required

            This value object contains the price margin for this entity.

            Additional properties are NOT allowed.

            Hide margin attributes Show margin attributes object
            • marginRule object Required

              The margin rule applied. Possible values: Markup, Margin, SplitMargin or ErpMinusDiscount

              Additional properties are NOT allowed.

              Hide marginRule attribute Show marginRule attribute object
              • name string | null

                The name of the enumeration.

            • value number(double) | null Required

              The value applied to this price margin. Should not be below 0 or above 999.

          • offerTypeMargins object | null

            Contains as key the name of the offer type and as value the price margin applied to each offer type for this specific provider instance. Price margins applied at the offer type level will override the price margin applied at the provider instance level. If no price margin is applied to a specific offer type of this provider instance then it will not be in the dictionary. This dictionary is optional.

            Hide offerTypeMargins attribute Show offerTypeMargins attribute object | null
            • * object Additional properties

              This value object contains the price margin for this entity.

              Additional properties are NOT allowed.

              Hide * attributes Show * attributes object
              • marginRule object Required

                The margin rule applied. Possible values: Markup, Margin, SplitMargin or ErpMinusDiscount

                Additional properties are NOT allowed.

                Hide marginRule attribute Show marginRule attribute object
                • name string | null

                  The name of the enumeration.

              • value number(double) | null Required

                The value applied to this price margin. Should not be below 0 or above 999.

          • status object

            The status for this entity. Possible values: Processing, Success, Failed

            Additional properties are NOT allowed.

            Hide status attribute Show status attribute object
            • name string | null

              The name of the enumeration.

          • customerCreationError object

            The creation error for this provider customer. This property will only have a diferent value than None if the Status is equal to Failed. Possible values: DomainExists, InvalidCompanyInfo, None or Unknown

            Additional properties are NOT allowed.

            Hide customerCreationError attribute Show customerCreationError attribute object
            • name string | null

              The name of the enumeration.

      • customerAssociations array[object] | null

        The list of partners associated to a customer

        The viewmodel for the customer relationships.

        Hide customerAssociations attributes Show customerAssociations attributes object
        • resellerId string(uuid) | null

          The reseller id.

        • name string | null

          The name of the partner.

    • paginationParameters object

      A model that is used to encapsulate the parameters needed to perform pagination queries.

      Additional properties are NOT allowed.

      Hide paginationParameters attributes Show paginationParameters attributes object
      • pageNumber integer(int32)

        Indicates the number of the current page.

      • pageSize integer(int32)

        The number of items that should be returned at most per page.

    • totalPages integer(int32)

      The total number of pages available for the specified parameters and page size.

    • totalCount integer(int32)

      The total number of results available for the specified parameters. Note this is typically not equal to the Count of items in the Items property, will only be equal if all the items fit in the first page.

    • hasPreviousPage boolean

      Indicates if there is a previous page.

    • hasNextPage boolean

      Indicates if there is a next page.

    • continuationToken string | null

      The token to continue to retrieve the paginated items.
  • 400

    Bad Request

    Hide response attributes Show response attributes object
    • statusCode integer(int32)

      The HTTP status code that represents a specific error scenario.

    • type string | null

      The type of error that occurred.

    • description string | null

      Describes the error scenario that occurred.

    • correlationId string | null

      The correlationId of the request that originated the error.

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
      • propertyName string | null

        The name of the property involved in the error.

      • description array[string] | null

        A description of each error associated with the given property.
  • 401

    Unauthorized

  • 403

    Forbidden

  • 500

    Internal Server Error

    Hide response attributes Show response attributes object
    • statusCode integer(int32)

      The HTTP status code that represents a specific error scenario.

    • type string | null

      The type of error that occurred.

    • description string | null

      Describes the error scenario that occurred.

    • correlationId string | null

      The correlationId of the request that originated the error.

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
      • propertyName string | null

        The name of the property involved in the error.

      • description array[string] | null

        A description of each error associated with the given property.
GET /v1/Customers 
curl \
 --request GET 'https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/Customers' \
 --header "X-Tenant: portal.cloudcockpit.com" \
 --header "Authorization: Bearer eyJ0eXAiO..." \
 --header "X-Correlation-Id: string"