List customers

GET

/customers

const url = 'https://api.pipevest.com/v1/customers?page=1&limit=10&identificationType=SSN';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'x-client-id': '<x-client-id>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.pipevest.com/v1/customers?page=1&limit=10&identificationType=SSN' \
  --header 'Authorization: Bearer <token>' \
  --header 'x-client-id: <x-client-id>'

Authorizations

bearerAuth
clientId

Parameters

Query Parameters

page

integer

default: 1 >= 1

limit

integer

default: 10 >= 1 <= 100

isActive

boolean

search

string

Matches firstName, lastName, identificationNumber or referenceId.

identificationType

string

Allowed values: SSN PASSPORT DRIVER_LICENSE NATIONAL_ID TAX_ID OTHER

Responses

200

Paginated list of customers

application/json

object

data

Array<object>

object

string

organizationId

string

firstName

string

lastName

string

msisdn

string

nullable

isActive

boolean

identificationNumber

string

nullable

identificationType

string

Allowed values: SSN PASSPORT DRIVER_LICENSE NATIONAL_ID TAX_ID OTHER

referenceId

string

nullable

createdAt

string format: date-time

updatedAt

string format: date-time

pagination

object

page

integer

limit

integer

total

integer

totalPages

integer

Example

{
  "data": [
    {
      "id": "clx0a1b2c3d4e5f6g7h8i9j0k",
      "organizationId": "clorgb2c3d4e5f6g7h8i9j0k1",
      "firstName": "John",
      "lastName": "Doe",
      "msisdn": "260971234567",
      "isActive": true,
      "identificationType": "SSN"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 42,
    "totalPages": 5
  }
}

401

Authentication failed

application/json

object

error

string

message

string

Example

{
  "error": "Unauthorized",
  "message": "Invalid organization authentication token"
}