Skip to content
API Reference

List For User

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

Overview

The List For 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.

FieldTypeNotes
idstringStable identifier, prefixed per resource type.
objectstringThe resource name, useful when handling webhook payloads.
created_attimestampISO 8601, always UTC.
updated_attimestampISO 8601, always UTC.

Making requests

All requests go to https://api.paycux.com/v1 over HTTPS. Send the API key as a bearer token; request and response bodies are JSON.

1import Paycux from '@paycux/node';
2
3const paycux = new Paycux(process.env.PAYCUX_API_KEY);
4
5const result = await paycux.organizations.list();
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.

StatusCodeMeaning
400invalid_requestA required field is missing or malformed.
401unauthorizedThe API key is missing, revoked, or from another environment.
404not_foundNo record with that ID in this environment.
429rate_limit_exceededBack off and retry after the interval in Retry-After.