Allo

List members

Lists the members of one of your accounts, oldest first. The account itself is not in the list. Requires the PARTNER scope.

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

Lists the members of one of your accounts, oldest first, with their role, their numbers and whether they have signed in. The account itself is not in the list.

  • page starts at 1 and size defaults to 20, up to 100. The response carries the usual pagination object, see Pagination.
  • Each member's id is the holder_id to send to Order eSIM for that member's number.
  • activated is true once the member has signed in on a device.
  • status is the member's status: ACTIVE, or SUSPENDED while the account is suspended.
  • An account your API key did not create, or one already deactivated, returns 404 PARTNER_ACCOUNT_NOT_FOUND.

To add a member, call Add member. To remove one, call Remove member.

Authorization

Authorizationstring · headerrequired

Api-Key ak_live_…

Path parameters

idstringrequired

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

Query parameters

pageinteger

Page number (1-indexed)

sizeinteger

Results per page

Responses

200The account's members
dataobject[]
8 fields
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 fields
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