API ReferenceUsers
Search users by email
Looks up a user by email across the platform, regardless of which integrator they belong to. Returns a single-element array holding only the id of the matching user, or an empty array when the email is not registered.
Authorization
ApiKeyAuth x-api-key<token>
API key for integrator authentication
In: header
Query Parameters
email*string
Header Parameters
x-api-key*string
API key for authentication
Response Body
application/json
application/json
application/json
import { PaytrieAPI, configure } from '@paytrie/sdk'configure({ headers: { 'x-api-key': process.env.PAYTRIE_API_KEY! } })const { data } = await PaytrieAPI.listUsers({ email: "user@example.com"}){ "success": true, "data": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "accessibleBy": [ "jwt" ] } ]}{ "success": false, "errors": [ { "field": "string", "message": "string" } ]}{ "success": false, "errors": [ { "field": "string", "message": "string" } ]}