## List organizations

`embed.organizations.list(**kwargs) -> PageNumberSchema<{ id, created_at, name, 3 more}>`

**get** `/v1/organizations`

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.

### Parameters

- `external_id: String`

  List organizations by their external ID.

- `name: String`

  List organizations by name (partial match supported).

- `page_number: Integer`

  Results page number. Starts at page 1.

- `page_size: Integer`

  Page size. Max value: 1000

- `sort_by: String`

  Sort By.

- `sort_order: :asc | :desc`

  Sort Order.

  - `:asc`

  - `:desc`

- `correlation_id: String`

- `request_id: String`

### Returns

- `{ id, created_at, name, 3 more}`

  - `id: String`

    Straddle's unique identifier for the organization.

  - `created_at: Time`

    Timestamp of when the organization was created.

  - `name: String`

    The name of the organization.

  - `updated_at: Time`

    Timestamp of the most recent update to the organization.

  - `external_id: String`

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

  - `metadata: Hash[Symbol, String]`

    Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the organization in a structured format.

### Example

```ruby
require "straddle"

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

page = straddle.embed.organizations.list

puts(page)
```

#### Response

```json
{
  "data": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "created_at": "2019-12-27T18:11:19.117Z",
      "name": "name",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "external_id": "external_id",
      "metadata": {
        "foo": "string"
      }
    }
  ],
  "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"
}
```