User

User in the Paycux API: the endpoints, the fields they accept and return, and a working request in three languages.

Overview

The User resource is part of the Paycux API. Every field below is returned on every representation of the object, so you can rely on its shape across list, read and write calls.

Field	Type	Notes
id	string	Stable identifier, prefixed per resource type.
object	string	The resource name, useful when handling webhook payloads.
created_at	timestamp	ISO 8601, always UTC.
updated_at	timestamp	ISO 8601, always UTC.

Endpoints

Every endpoint is authenticated with a bearer token and scoped to the environment the key belongs to.

Method	Path	What it does
GET	/user_management/users/:id	Get a user
GET	/user_management/users/external_id/:external_id	Get a user by external ID
GET	/user_management/users	List users
POST	/user_management/users/:id/email_verification/confirm	Verify email
POST	/user_management/users/:id/email_verification/send	Send verification email
GET	/user_management/users/:user_id/authorized_applications	List authorized applications

Get a user

GET /user_management/users/:id — get a user.

1import Paycux from '@paycux/node';
2 
3const paycux = new Paycux(process.env.PAYCUX_API_KEY);
4 
5const result = await paycux.get_a_user();
6console.log(result);

Get a user by external ID

GET /user_management/users/external_id/:external_id — get a user by external ID.

1import Paycux from '@paycux/node';
2 
3const paycux = new Paycux(process.env.PAYCUX_API_KEY);
4 
5const result = await paycux.get_a_user_by_external_id();
6console.log(result);

List users

GET /user_management/users — list users.

1import Paycux from '@paycux/node';
2 
3const paycux = new Paycux(process.env.PAYCUX_API_KEY);
4 
5const result = await paycux.list_users();
6console.log(result);

Verify email

POST /user_management/users/:id/email_verification/confirm — verify email.

1import Paycux from '@paycux/node';
2 
3const paycux = new Paycux(process.env.PAYCUX_API_KEY);
4 
5const result = await paycux.verify_email();
6console.log(result);

Send verification email

POST /user_management/users/:id/email_verification/send — send verification email.

1import Paycux from '@paycux/node';
2 
3const paycux = new Paycux(process.env.PAYCUX_API_KEY);
4 
5const result = await paycux.send_verification_email();
6console.log(result);

List authorized applications

GET /user_management/users/:user_id/authorized_applications — list authorized applications.

1import Paycux from '@paycux/node';
2 
3const paycux = new Paycux(process.env.PAYCUX_API_KEY);
4 
5const result = await paycux.list_authorized_applications();
6console.log(result);

Errors

Errors return a JSON body with a machine-readable code, a human-readable message and, for validation failures, the offending field.

Status	Code	Meaning
400	invalid_request	A required field is missing or malformed.
401	unauthorized	The API key is missing, revoked, or from another environment.
404	not_found	No record with that ID in this environment.
429	rate_limit_exceeded	Back off and retry after the interval in Retry-After.