List customers

customers.list(**kwargs) -> PageNumberSchema<{ id, created_at, email, 6 more}>

get/v1/customers

Lists or searches customers connected to your account. All supported query parameters are optional. If none are provided, the response will include all customers connected to your account. This endpoint supports advanced sorting and filtering options.

ParametersExpand Collapse

created_from: Time

Start date for filtering by created_at date.

formatdate-time

created_to: Time

End date for filtering by created_at date.

formatdate-time

email: String

Filter customers by email address.

external_id: String

Filter by your system's external_id.

name: String

Filter customers by name (partial match).

page_number: Integer

Page number for paginated results. Starts at 1.

formatint32

page_size: Integer

Number of results per page. Maximum: 1000.

formatint32

search_text: String

General search term to filter customers.

sort_by: :name | :created_at

Accepts one of the following:

:name

:created_at

sort_order: :asc | :desc

Accepts one of the following:

:asc

:desc

status: Array[:pending | :review | :verified | 2 more]

Filter customers by their current status.

Accepts one of the following:

:pending

:review

:verified

:inactive

:rejected

types: Array[:individual | :business]

Filter by customer type individual or business.

Accepts one of the following:

:individual

:business

correlation_id: String

request_id: String

straddle_account_id: String

ReturnsExpand Collapse

{ id, created_at, email, 6 more}

id: String

Unique identifier for the customer.

formatuuid

created_at: Time

Timestamp of when the customer record was created.

formatdate-time

email: String

The customer's email address.

formatemail

name: String

Full name of the individual or business name.

phone: String

The customer's phone number in E.164 format.

status: :pending | :review | :verified | 2 more

Accepts one of the following:

:pending

:review

:verified

:inactive

:rejected

type: :individual | :business

Accepts one of the following:

:individual

:business

updated_at: Time

Timestamp of the most recent update to the customer record.

formatdate-time

external_id: String

Unique identifier for the customer in your database, used for cross-referencing between Straddle and your systems.

List customers

require "straddle"

straddle = Straddle::Client.new(
  api_key: "My API Key",
  environment: "production" # defaults to "sandbox"
)

page = straddle.customers.list

puts(page)

{
  "data": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "created_at": "2019-12-27T18:11:19.117Z",
      "email": "dev@stainless.com",
      "name": "name",
      "phone": "+46991022",
      "status": "pending",
      "type": "individual",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "external_id": "external_id"
    }
  ],
  "meta": {
    "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "api_request_timestamp": "2019-12-27T18:11:19.117Z",
    "max_page_size": 0,
    "page_number": 0,
    "page_size": 0,
    "sort_by": "sort_by",
    "sort_order": "asc",
    "total_items": 0,
    "total_pages": 0
  },
  "response_type": "object"
}

Returns Examples

{
  "data": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "created_at": "2019-12-27T18:11:19.117Z",
      "email": "dev@stainless.com",
      "name": "name",
      "phone": "+46991022",
      "status": "pending",
      "type": "individual",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "external_id": "external_id"
    }
  ],
  "meta": {
    "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "api_request_timestamp": "2019-12-27T18:11:19.117Z",
    "max_page_size": 0,
    "page_number": 0,
    "page_size": 0,
    "sort_by": "sort_by",
    "sort_order": "asc",
    "total_items": 0,
    "total_pages": 0
  },
  "response_type": "object"
}