Get Contact — GET /v1/contacts/{contactId} Reference

Use this endpoint to fetch the full details of a single contact by its unique ID. The response includes the contact’s current status, payment direction, bank account summary, tax information, and whether the contact is currently payment-ready.

Base URL

GET https://api.cleo-pay.com/v1/contacts/{contactId}

Authentication

All requests must include a Bearer token in the Authorization header.

Authorization: Bearer <token>

Path Parameters

string

required

The unique identifier of the contact to retrieve. This is the same ID referenced as contact.id in payables.

Response

Returns a Contact object.

string

Unique identifier for the contact.

string

The contact type: payee or business.

string

The contact’s current status: active, archived, or revoked.

string | null

The contact’s display name, if set.

string[]

Email addresses associated with the contact. Always empty for business-type contacts.

string | null

Phone number for the contact. Always null for business-type contacts.

string

Indicates the allowed payment direction for this contact. One of:

bidirectional — can both send and receive payments
can_pay — can only send payments
can_be_paid — can only receive payments
none — no payment capability configured

number | null

Net payment terms in days, if configured.

object | null

Summary of the contact’s linked bank account. null if no bank account has been added.

Show bankAccount fields

string

Last four digits of the bank account number.

object | null

Tax information for the contact. null if no tax info has been provided.

Show taxInfo fields

string | null

Legal name associated with the tax ID.

string | null

Type of tax ID: ein or ssn.

string | null

Last four digits of the tax ID. The full tax ID is never returned.

boolean

Whether this contact can currently receive payments. A contact is payment-ready when a valid bank account is on file and the contact is in active status.

datetime

ISO 8601 timestamp of when the contact was created.

datetime | null

ISO 8601 timestamp of the most recent update. null if the contact has never been updated.

datetime | null

ISO 8601 timestamp of when the contact was archived. null if the contact is not archived.

Example Request

curl

curl --request GET \
  --url "https://api.cleo-pay.com/v1/contacts/cnt_01hq1z2k3m4n5p6q7r8s9t0u" \
  --header "Authorization: Bearer <token>"

Example Response

200

{
  "id": "cnt_01hq1z2k3m4n5p6q7r8s9t0u",
  "type": "payee",
  "status": "active",
  "displayName": "Acme Supplies LLC",
  "emails": ["billing@acmesupplies.com"],
  "phone": "+15550001234",
  "paymentDirection": "can_be_paid",
  "netTerms": 30,
  "bankAccount": {
    "last4": "7890"
  },
  "taxInfo": {
    "legalName": "Acme Supplies LLC",
    "taxIdType": "ein",
    "taxIdMask": "6789"
  },
  "paymentReady": true,
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-03-01T08:00:00Z",
  "archivedAt": null
}

The paymentReady flag reflects whether a payment can be initiated to this contact right now. A contact may have a bank account on file but still have paymentReady: false if their account is in a non-active status.

Payables

Bank Accounts

Contacts

Payments

Get Contact — GET /v1/contacts/{contactId} Reference

Base URL

Authentication

Path Parameters

Response

Example Request

Example Response

​Base URL

​Authentication

​Path Parameters

​Response

​Example Request

​Example Response

Base URL

Authentication

Path Parameters

Response

Example Request

Example Response