Accounts

List accounts

Changed on

Returns a list of accounts associated with your Straddle platform integration. The accounts are returned sorted by creation date, with the most recently created accounts appearing first. This endpoint supports advanced sorting and filtering options.

get/v1/accounts

Request

  • Base URL
    https://sandbox.straddle.com
  • URL
    https://sandbox.straddle.com/v1/accounts
  • Auth
    HTTP bearer

Query parameters

page_numberinteger

Results page number. Starts at page 1. Default value: 1

page_sizeinteger

Page size. Default value: 100. Max value: 1000

sort_bystring

Sort By. Default value: 'id'.

sort_order'asc' | 'desc'

Sort Order. Default value: 'asc'.

search_textstring
status'created' | 'onboarding' | 'active' | 'rejected' | 'inactive'
type'business'
external_idstring

Headers

request-idstring

Optional client generated identifier to trace and debug a request.

correlation-idstring

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

Response

OK

response_type'object' | 'array' | 'error' | 'none' required

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.

Changes

  • de39a60c562eRevision changes
    • breaking

      removed the required property //// from the response with the status (media type: text/plain)

    • breaking

      removed the required property //// from the response with the status (media type: application/json)

    • breaking

      removed the required property //// from the response with the status (media type: text/json)

    • breaking

      removed the required property //// from the response with the status (media type: text/plain)

    • breaking

      removed the required property //// from the response with the status (media type: application/json)

    • breaking

      removed the required property //// from the response with the status (media type: text/json)

    • warning

      removed the optional property //// from the response with the status (media type: text/plain)

    • warning

      removed the optional property //// from the response with the status (media type: application/json)

    • warning

      removed the optional property //// from the response with the status (media type: text/json)

  • 6e13cd88cda9Revision changes
    • info

      added the new optional query request parameter external_id

    • info

      added the optional property //// to the response with the status (media type: text/plain)

    • info

      added the optional property //// to the response with the status (media type: application/json)

    • info

      added the optional property //// to the response with the status (media type: text/json)

    • info

      added the required property //// to the response with the status (media type: text/plain)

    • info

      added the required property //// to the response with the status (media type: application/json)

    • info

      added the required property //// to the response with the status (media type: text/json)

    • info

      added the required property //// to the response with the status (media type: text/plain)

    • info

      added the required property //// to the response with the status (media type: application/json)

    • info

      added the required property //// to the response with the status (media type: text/json)