Skip to main content
POST
/
business
/
customers
/
get-all
List contacts for a business
curl --request POST \
  --url https://api.sdev.banking.ingopayments.tech/api/v4/business/customers/get-all \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "api_key": "YOUR_API_KEY",
  "user_id": "user-8f3a2b1c-0e44-4f2d-9a11-7b23cc90d1ef",
  "business_id": "buss-2ef94c60-5a11-4d72-a3c1-5be7fab0123e"
}
'
{
  "status": "success",
  "message": "operation completed",
  "data": {
    "items": [
      {
        "id": "bcus-...",
        "contact_type": "customers",
        "first_name": "<string>",
        "last_name": "<string>",
        "business_name": "<string>",
        "email": "jane.doe@example.com",
        "phone_number": "+12125551234"
      }
    ],
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total": 100,
      "sort": "created_at:desc",
      "search": "jane"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.ingopayments.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

api_key
string
header
required

Program API key identifying your integration. Pass as the api_key HTTP header (preferred) or as an api_key field in the JSON request body. Required on every request in addition to the HMAC Authorization header.

Body

application/json
user_id
string
required

Identifier of the target user. Required when the endpoint operates on a specific user.

Example:

"user-8f3a2b1c-0e44-4f2d-9a11-7b23cc90d1ef"

business_id
string
required

Identifier of the target business. Required when the endpoint operates on a specific business.

Example:

"buss-2ef94c60-5a11-4d72-a3c1-5be7fab0123e"

api_key
string

Program API key. Accepted either in the api_key HTTP header or as this body field.

type
string

Optional contact type filter.

page
integer
default:1

Page number, 1-indexed. Defaults to 1 when omitted.

Required range: x >= 1
per_page
integer
default:10

Page size. Defaults to 10 when omitted.

Required range: 1 <= x <= 500

Response

Success.

status
enum<string>
required
Available options:
success
message
string
required
Example:

"operation completed"

data
object

Endpoint-specific payload; shape varies per operation.