Ir al contenido
FactuCat Docs

Listar clientes

GET
/customers
FACTUCAT_API_URL="${FACTUCAT_API_URL:-https://sandbox.factucat.com/api/v1}"


curl --fail-with-body --request GET \
  --url "$FACTUCAT_API_URL/customers" \
  --header "X-API-Key: $FACTUCAT_API_KEY"

Authorizations

Sección titulada «Authorizations»

Parameters

Sección titulada «Parameters»

Query Parameters

Sección titulada «Query Parameters»
query
string
>= 1 characters <= 120 characters
limit
integer
>= 1 <= 100
offset
integer
<= 1000000

Responses

Sección titulada «Responses»

200

Sección titulada «200»

Operación exitosa

Media typeapplication/json
object
data
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
userId
required
string
>= 1 characters
legalName
required
string
rfc
required
string
postalCode
required
string
taxRegime
required
string
preferredCfdiUse
string | null
fiscalResidence
string
taxId
string
email
string format: email
/^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$/
whatsappPhone
string
sendInvoices
required
boolean
invoiceLanguage
required
string
Allowed values: es en
currency
required
string
Allowed values: MXN USD EUR
createdAt
required
string format: date-time
/^(?:(?:\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))$/
updatedAt
required
string format: date-time
/^(?:(?:\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))$/
meta
required
object
requestId
required
string
>= 1 characters
idempotencyKey
string
>= 1 characters
pagination
object
limit
required
integer
> 0 <= 9007199254740991
offset
required
integer
<= 9007199254740991
hasMore
required
boolean
nextCursor
string | null

400

Sección titulada «400»

Datos inválidos

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: bad_request conflict csd_required forbidden internal_error pac_unavailable invalid_api_key invalid_json method_not_allowed missing_api_key missing_idempotency_key missing_scope not_found plan_required rate_limit_exceeded validation_error invalid_input INVALID_ISSUE_DATE idempotency_conflict idempotency_in_progress
message
required
string
>= 1 characters
requestId
required
string
>= 1 characters
retryable
required
boolean
reason
string

401

Sección titulada «401»

API key ausente, inválida o de otro ambiente

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: bad_request conflict csd_required forbidden internal_error pac_unavailable invalid_api_key invalid_json method_not_allowed missing_api_key missing_idempotency_key missing_scope not_found plan_required rate_limit_exceeded validation_error invalid_input INVALID_ISSUE_DATE idempotency_conflict idempotency_in_progress
message
required
string
>= 1 characters
requestId
required
string
>= 1 characters
retryable
required
boolean
reason
string

403

Sección titulada «403»

Plan inactivo o permisos insuficientes

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: bad_request conflict csd_required forbidden internal_error pac_unavailable invalid_api_key invalid_json method_not_allowed missing_api_key missing_idempotency_key missing_scope not_found plan_required rate_limit_exceeded validation_error invalid_input INVALID_ISSUE_DATE idempotency_conflict idempotency_in_progress
message
required
string
>= 1 characters
requestId
required
string
>= 1 characters
retryable
required
boolean
reason
string

404

Sección titulada «404»

Recurso no encontrado

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: bad_request conflict csd_required forbidden internal_error pac_unavailable invalid_api_key invalid_json method_not_allowed missing_api_key missing_idempotency_key missing_scope not_found plan_required rate_limit_exceeded validation_error invalid_input INVALID_ISSUE_DATE idempotency_conflict idempotency_in_progress
message
required
string
>= 1 characters
requestId
required
string
>= 1 characters
retryable
required
boolean
reason
string

405

Sección titulada «405»

Método no permitido

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: bad_request conflict csd_required forbidden internal_error pac_unavailable invalid_api_key invalid_json method_not_allowed missing_api_key missing_idempotency_key missing_scope not_found plan_required rate_limit_exceeded validation_error invalid_input INVALID_ISSUE_DATE idempotency_conflict idempotency_in_progress
message
required
string
>= 1 characters
requestId
required
string
>= 1 characters
retryable
required
boolean
reason
string

409

Sección titulada «409»

Conflicto o solicitud en curso. error.reason es opcional; duplicate_rfc indica que ya existe un cliente con ese RFC en la cuenta; stamp_in_progress indica que el documento se está timbrando: consúltalo antes de reintentar.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: bad_request conflict csd_required forbidden internal_error pac_unavailable invalid_api_key invalid_json method_not_allowed missing_api_key missing_idempotency_key missing_scope not_found plan_required rate_limit_exceeded validation_error invalid_input INVALID_ISSUE_DATE idempotency_conflict idempotency_in_progress
message
required
string
>= 1 characters
requestId
required
string
>= 1 characters
retryable
required
boolean
reason
string

429

Sección titulada «429»

Límite de solicitudes alcanzado

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: bad_request conflict csd_required forbidden internal_error pac_unavailable invalid_api_key invalid_json method_not_allowed missing_api_key missing_idempotency_key missing_scope not_found plan_required rate_limit_exceeded validation_error invalid_input INVALID_ISSUE_DATE idempotency_conflict idempotency_in_progress
message
required
string
>= 1 characters
requestId
required
string
>= 1 characters
retryable
required
boolean
reason
string

Headers

Sección titulada «Headers»
Retry-After
integer

Segundos antes de reintentar.

500

Sección titulada «500»

Error interno

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: bad_request conflict csd_required forbidden internal_error pac_unavailable invalid_api_key invalid_json method_not_allowed missing_api_key missing_idempotency_key missing_scope not_found plan_required rate_limit_exceeded validation_error invalid_input INVALID_ISSUE_DATE idempotency_conflict idempotency_in_progress
message
required
string
>= 1 characters
requestId
required
string
>= 1 characters
retryable
required
boolean
reason
string

503

Sección titulada «503»

PAC temporalmente no disponible

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: bad_request conflict csd_required forbidden internal_error pac_unavailable invalid_api_key invalid_json method_not_allowed missing_api_key missing_idempotency_key missing_scope not_found plan_required rate_limit_exceeded validation_error invalid_input INVALID_ISSUE_DATE idempotency_conflict idempotency_in_progress
message
required
string
>= 1 characters
requestId
required
string
>= 1 characters
retryable
required
boolean
reason
string