Allo

Lister les membres

Liste les membres de l'un de vos comptes, du plus ancien au plus récent, avec leur rôle, leurs numéros et leur état de connexion. Le compte lui-même…

GET/v2/api/partner/accounts/{id}/members

Liste les membres de l'un de vos comptes, du plus ancien au plus récent, avec leur rôle, leurs numéros et leur état de connexion. Le compte lui-même n'apparaît pas dans la liste.

  • page commence à 1 et size vaut 20 par défaut, jusqu'à 100. La réponse porte l'objet pagination habituel, voir Pagination.
  • L'id de chaque membre est le holder_id à envoyer à Commander une eSIM pour le numéro de ce membre.
  • activated vaut true dès que le membre s'est connecté sur un appareil.
  • status est le statut du membre : ACTIVE, ou SUSPENDED tant que le compte est suspendu.
  • Un compte que votre API key n'a pas créé, ou déjà désactivé, renvoie 404 PARTNER_ACCOUNT_NOT_FOUND.

Pour ajouter un membre, appelez Ajouter un membre. Pour en retirer un, appelez Retirer un membre.

Autorisation

Authorizationstring · headerrequis

Api-Key ak_live_…

Paramètres de chemin

idstringrequis

The account id returned by Create account (usr-*).

Paramètres de requête

pageinteger

Page number (1-indexed)

sizeinteger

Results per page

Réponses

200The account's members
dataobject[]
8 champs
idstring

The member's user id (usr-*). Pass it as holder_id to Order eSIM to register the member's eSIM to the member.

account_idstring

The account the member was added to.

emailstring

The member's login.

namestring
roleenum<string>

ADMINMANAGERMEMBER

phone_numbersstring[]

The member's own numbers.

statusstring

The member's status: ACTIVE, or SUSPENDED while the account is suspended with Suspend account.

activatedboolean

True once the member has signed in on a device.

paginationobject
5 champs
pageinteger
sizeinteger
total_countinteger<int64>
total_pagesinteger
has_moreboolean
401
403The API key lacks the PARTNER scope.
errorobject
404No account with this id was provisioned by your API key, or the account is deactivated (PARTNER_ACCOUNT_NOT_FOUND).
errorobject
429