List Accounts

List all accounts with filter, sort and pagination support.

Response Body

Field	Description	Type	Notes
data	List of Accounts	Account Objects (Get Account by Id - Response Body) Array	See - Get Account by Id - Account Object (Response Body)
metadata	List account metadata	Metadata Object	See - Metadata Object

Metadata Object

Field	Description	Type	Notes
filter	Filter string that contains search parameters	String
sort	Sort string that contains sorting criteria	String
pagination	Pagination Info	Pagination Object	See - Pagination Object

Pagination Object

Field	Description	Type	Notes
pageNumber	Page number	Integer	0 to x
pageSize	Page size	Integer
totalRecords	Total number of records	Integer

Query Parameters

• filter string

  Optional - Filter. searchTerm - matches account name and contact email containing searchTerm value.
  Apart from searchTerm filter can also be applied on fields like id, notId (For exclusion), orgId (maps to mspId/resellerId/distiId), partnetId (maps to resellerId), resellerId, type.
  Other account root elements can also be used as filters like name, status, domain, website, externalCustomerId etc.

• sort string

  Optional - Sort order. default desc:updateTs

• pageNumber int32

  Optional - Page number >= 0. default 0

• pageSize int32

  Optional - Size of each page. default 25

Responses

• 200

---

application/json

• Schema
• List Accounts Success

---

Schema

{
  "data": [
    {
      "id": "E2A81C2E-B017-4B6C-BA99-A9B496206A3C",
      "insertTs": "2022-02-04T01:01:20",
      "updateTs": "2022-02-04T02:50:20",
      "status": "active",
      "externalId": "local-acc-1",
      "name": "Local Account1",
      "provisionCountry": "United States",
      "contacts": [
        {
          "type": "admin",
          "email": "admin@localaccount1.com",
          "firstName": "Leo",
          "lastName": "Liu"
        }
      ]
    },
    {
      "id": "E033F7E5-444A-4A8A-8DDA-18B69E06F6AA",
      "insertTs": "2022-03-16T18:36:30",
      "updateTs": "2022-03-16T18:36:37",
      "status": "active",
      "externalId": "local-acc-3",
      "name": "Local Account3",
      "provisionCountry": "South Africa",
      "contacts": [
        {
          "type": "admin",
          "email": "admin@localaccount3.com",
          "firstName": "Admin",
          "lastName": "User",
          "address": {
            "addressLine1": "1 St",
            "city": "Johannesburg",
            "state": "Gauteng",
            "country": "South Africa",
            "postalCode": "2198"
          }
        }
      ]
    }
  ],
  "metadata": {
    "filter": "pageSize=25&pageNumber=0&sort=asc:updateTs&filter=status:provisioning_failure",
    "sort": "asc:updateTs",
    "pagination": {
      "pageNumber": 0,
      "pageSize": 25,
      "totalRecords": 2
    }
  }
}

Loading...