Organizations

List organizations

Changed on

Retrieves a list of organizations associated with your Straddle integration. The organizations are returned sorted by creation date, with the most recently created organizations appearing first. This endpoint supports advanced sorting and filtering options to help you find specific organizations.

get/v1/organizations

Request

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

Query parameters

namestring

List organizations by name (partial match supported).

external_idstring

List organizations by their external ID.

page_numberinteger

Results page number. Starts at page 1.

page_sizeinteger

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

Page size. Max value: 1000

sort_bystring

Sort By. Default value: 'id'.

Sort By.

sort_order'asc' | 'desc'

Sort Order. Default value: 'asc'.

Sort Order.

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

  • 4c4191aab91dRevision changes
    • info

      removed the Asc enum value from the / response property for the response status (media type: text/plain)

    • info

      removed the Asc enum value from the / response property for the response status (media type: application/json)

    • info

      removed the Asc enum value from the / response property for the response status (media type: text/json)

    • info

      removed the Desc enum value from the / response property for the response status (media type: text/plain)

    • info

      removed the Desc enum value from the / response property for the response status (media type: application/json)

    • info

      removed the Desc enum value from the / response property for the response status (media type: text/json)

  • f9fe2a77d949Revision changes
    • warning

      added the new Asc enum value to the / response property for the response status (media type: text/plain)

    • warning

      added the new Asc enum value to the / response property for the response status (media type: application/json)

    • warning

      added the new Asc enum value to the / response property for the response status (media type: text/json)

    • warning

      added the new Desc enum value to the / response property for the response status (media type: text/plain)

    • warning

      added the new Desc enum value to the / response property for the response status (media type: application/json)

    • warning

      added the new Desc enum value to the / response property for the response status (media type: text/json)