clients

Every client with its organizations, in one call

The whole tree the caller can see: their clients, and inside each one the organizations they have access to.

It exists to save the N+1 that building a client picker otherwise costs. An app always gets exactly one client — its own — with every organization of it.

The two pairs of pagination parameters are independent: offset/limit page the clients, offsetOrganizations/limitOrganizations page the organizations inside each one.

get/clients_organizations

Request

  • Base URL: https://api.planvortex.com/v1.0.0
  • URL: https://api.planvortex.com/v1.0.0/clients_organizations
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (client credentials, token URL https://api.planvortex.com/v1.0.0/oauth/token)

Query parameters

offsetinteger

Clients to skip

limitinteger

Clients per page

offsetOrganizationsinteger

Organizations to skip inside each client

limitOrganizationsinteger

Organizations per page inside each client

getUseboolean

Send true to add each client's plan consumption. It costs several aggregations per client, so leave it off for a picker.

Response

Clients, each with its organizations

totalinteger required

Clients the caller can see.

Example response

{
  "clients": [
    {
      "_id": "66d04a6a427f4c43b9d97f54",
      "organizations": [
        {
          "_id": "66d04a6a427f4c43b9d97f54"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.