Count of members matching the filters - Podero Documentation

GET

/

api

/

partners

/

v2.0

/

org

/

{org_id}

/

users

/

count

Count of members matching the filters

curl --request GET \
  --url https://api.example.com/api/partners/v2.0/org/{org_id}/users/count \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.example.com/api/partners/v2.0/org/{org_id}/users/count"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/api/partners/v2.0/org/{org_id}/users/count', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/partners/v2.0/org/{org_id}/users/count",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/partners/v2.0/org/{org_id}/users/count"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/partners/v2.0/org/{org_id}/users/count")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "total": 123
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

org_id

string<uuid>

required

The organization ID of the requested users

Query Parameters

q

string

Search by name, email, external user id, town, or exact member id

status

enum<string>[] | null

Only members whose operational status is one of these buckets (repeatable)

Available options:

disabled,

communication-error,

steering-error,

actions-required,

troubleshooting,

communication-warning,

steering-warning,

normal

role

enum<string>

Only members with this organization role

Available options:

admin,

staff,

user,

guest

device_kind

enum<string>

Only members owning a device of this kind (any = at least one device)

Available options:

any,

ev,

hp,

inv,

wb

device_steering

enum<string>

Only members owning an operational device that is steered (on) or not (off). Composes with device_kind as a same-device condition: both must hold for one and the same device, so a member with a steered EV and an unsteered inverter matches device_kind=inv&device_steering=off but not device_kind=ev&device_steering=off. A member with no devices matches neither value.

Available options:

on,

off

manufacturer

string

Only members owning an operational device from this manufacturer

joined_after

string<date>

Only members who joined on or after this UTC day

joined_before

string<date>

Only members who joined on or before this UTC day

include_deleted

boolean

default:false

If true, includes soft-deleted

Response

200 - application/json

OK

Number of members matching the users-list filters — the filtered total the paginated list can't report itself, so the console can size its pager range and page count to the active filters instead of the org-wide total.

total

integer

required

Count of members matching the filters

curl --request GET \
  --url https://api.example.com/api/partners/v2.0/org/{org_id}/users/count \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.example.com/api/partners/v2.0/org/{org_id}/users/count"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/api/partners/v2.0/org/{org_id}/users/count', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/partners/v2.0/org/{org_id}/users/count",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/partners/v2.0/org/{org_id}/users/count"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/partners/v2.0/org/{org_id}/users/count")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "total": 123
}