Retrieve Customers

Retrieve customers matching the provided query parameters

SecurityOAuth2: OAuth2Flow
Request
query Parameters
page
integer <int32>

Page of records to get (default 0 = first page)

page_size
integer <int32>

Records to return per page (default = 20)

type
string

Type of Customer

Enum: "INDIVIDUAL" "CORPORATION"
status
string

Customer status.

Enum: "ACTIVE" "PENDING" "INACTIVE" "DISABLED"
header Parameters
Authorization
string

OAuth bearer token (see authentication flows)

x-l2f-request-id
string

Optional Unique ID per request, useful for fault resolution/diagnosis and audit.

Responses
200

Success

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Error

get/v1/customers
Response samples
application/json
{
  • "data": {
    },
  • "links": {
    }
}
© 2023 Layer2 Financial Inc. All Rights Reserved.