Skip to main content
GET
List Users

Authorizations

Authorization
string
header
required

Account Service Key, prefixed with pho_ask_, sent as Authorization: Bearer <key>. Acts on behalf of its owning account, subject to the permissions and credential restrictions of each operation. Account access tokens and OAuth grants also use the Bearer header. In organizations that require SSO, Account Service Keys are not accepted for managing the organization's SSO settings, deleting the organization, or checking whether it can be deleted.

Path Parameters

id
string
required
Pattern: ^pho_prj_[0-7][0-9a-hjkmnp-tv-z]{25}$

Query Parameters

messageCreatedBefore
string<date-time>

Exclusive creation-time bound on a matching Message

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
messageCreatedSince
string<date-time>

Inclusive creation-time bound on a matching Message

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
messageDirection
enum<string>

Received or sent Message. All message-prefixed filters must match the same Message.

Available options:
received,
sent
messageExcludeContentTypes
string

Comma-separated public content types to exclude from matching Messages. Requires messageResourceId. A group is excluded when its type or all its parts are excluded.

Maximum string length: 1024
messageResourceId
string

Resource ownership captured by a matching Message

Pattern: ^pho_res_[0-7][0-9a-hjkmnp-tv-z]{25}$
createdBefore
string<date-time>

Exclusive upper bound on createdAt, RFC 3339. Cannot combine with updatedAt bounds.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
createdSince
string<date-time>

Inclusive lower bound on createdAt, RFC 3339. Cannot combine with updatedAt bounds.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
order
enum<string>

Direction along orderBy; desc, the default, is newest first

Available options:
asc,
desc
orderBy
enum<string>

Sort timestamp; defaults to the filtered timestamp, otherwise created_at. Must match the time bounds.

Available options:
created_at,
updated_at
pageSize
integer

Items per page. A value above 100 returns at most 100 items.

Required range: 0 <= x <= 9007199254740991
pageToken
string

Token from nextPageToken. Keep the same Project and query.

Required string length: 1 - 4096
Pattern: ^[A-Za-z0-9_-]+\.[A-Za-z0-9_-]+$
platform
enum<string>

Restricts the page to one platform

Available options:
sms,
email,
whatsapp,
whatsapp_business,
imessage,
telegram
updatedBefore
string<date-time>

Exclusive upper bound on updatedAt, RFC 3339. Cannot combine with createdAt bounds.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
updatedSince
string<date-time>

Inclusive lower bound on updatedAt, RFC 3339. Cannot combine with createdAt bounds.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Response

A page of persisted Users in the requested order.

items
object[]
required

Unsupported platforms and records with unsupported data are omitted.

Example:
nextPageToken
string

Continue with this token, even if items is empty. Omitted when no more pages remain.

Required string length: 1 - 4096
Pattern: ^[A-Za-z0-9_-]+\.[A-Za-z0-9_-]+$