clients

Get root organizations inside client

Return a list of organizations inside the client

get/clients/{id_client}/organizations

Request

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

Path parameters

id_clientstring required

Client identifier

Query parameters

getUseboolean

Boolean determine if the server will response with the actual use of each client

offsetinteger

Number of records from which you will get clients (pagination)

limitinteger

The limit of records will be retrieved (pagination)

namestring

The limit of records will be retrieved (pagination)

Response

Successful operation

totalinteger required

Example response

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

Changes

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