List customers

CustomerSummaryPagedV1 Customers.List(, )

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

CustomerListParams parameters

DateTimeOffset createdFrom

Query param: Start date for filtering by created_at date.

formatdate-time

DateTimeOffset createdTo

Query param: End date for filtering by created_at date.

formatdate-time

string email

Query param: Filter customers by email address.

string externalID

Query param: Filter by your system's external_id.

string name

Query param: Filter customers by name (partial match).

Int pageNumber

Query param: Page number for paginated results. Starts at 1.

formatint32

Int pageSize

Query param: Number of results per page. Maximum: 1000.

formatint32

string searchText

Query param: General search term to filter customers.

SortBy sortBy

Query param

SortOrder sortOrder

Query param

IReadOnlyList<Status> status

Query param: Filter customers by their current status.

IReadOnlyList<Type> types

Query param: Filter by customer type individual or business.

string correlationID

Header param: Optional client generated identifier to trace and debug a series of requests.

string requestID

Header param: Optional client generated identifier to trace and debug a request.

string straddleAccountID

Header param: For use by platforms to specify an account_id to set the scope of a request.

formatuuid

ReturnsExpand Collapse

class CustomerSummaryPagedV1:

required IReadOnlyList<Data> Data

required string ID

Unique identifier for the customer.

formatuuid

required DateTimeOffset CreatedAt

Timestamp of when the customer record was created.

formatdate-time

required string Email

The customer's email address.

formatemail

required string Name

Full name of the individual or business name.

required string Phone

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

required Status Status

One of the following:

required Type Type

One of the following:

required DateTimeOffset UpdatedAt

Timestamp of the most recent update to the customer record.

formatdate-time

string? ExternalID

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

required Meta Meta

required string ApiRequestID

Unique identifier for this API request, useful for troubleshooting.

formatuuid

required DateTimeOffset ApiRequestTimestamp

Timestamp for this API request, useful for troubleshooting.

formatdate-time

required Int MaxPageSize

Maximum allowed page size for this endpoint.

formatint32

required Int PageNumber

Page number for paginated results.

formatint32

required Int PageSize

Number of items per page in this response.

formatint32

required string SortBy

The field that the results were sorted by.

required SortOrder SortOrder

One of the following:

required Int TotalItems

required Int TotalPages

The number of pages available.

formatint32

required ResponseType ResponseType

Indicates the structure of the returned content.

"object" means the data field contains a single JSON object.
"array" means the data field contains an array of objects.
"error" means the data field contains an error object with details of the issue.
"none" means no data is returned.

One of the following:

List customers

CustomerListParams parameters = new();

var page = await client.Customers.List(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}

{
  "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"
}