## List organizations

`client.Embed.Organizations.List(ctx, params) (*PageNumberSchema[OrganizationPagedV1Data], error)`

**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

- `params EmbedOrganizationListParams`

  - `ExternalID param.Field[string]`

    Query param: List organizations by their external ID.

  - `Name param.Field[string]`

    Query param: List organizations by name (partial match supported).

  - `PageNumber param.Field[int64]`

    Query param: Results page number. Starts at page 1.

  - `PageSize param.Field[int64]`

    Query param: Page size. Max value: 1000

  - `SortBy param.Field[string]`

    Query param: Sort By.

  - `SortOrder param.Field[EmbedOrganizationListParamsSortOrder]`

    Query param: Sort Order.

    - `const EmbedOrganizationListParamsSortOrderAsc EmbedOrganizationListParamsSortOrder = "asc"`

    - `const EmbedOrganizationListParamsSortOrderDesc EmbedOrganizationListParamsSortOrder = "desc"`

  - `CorrelationID param.Field[string]`

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

  - `RequestID param.Field[string]`

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

### Returns

- `type OrganizationPagedV1Data struct{…}`

  - `ID string`

    Straddle's unique identifier for the organization.

  - `CreatedAt Time`

    Timestamp of when the organization was created.

  - `Name string`

    The name of the organization.

  - `UpdatedAt Time`

    Timestamp of the most recent update to the organization.

  - `ExternalID string`

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

  - `Metadata map[string, string]`

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

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/straddleio/straddle-go"
  "github.com/straddleio/straddle-go/option"
)

func main() {
  client := straddle.NewClient(
    option.WithAPIKey("My API Key"),
  )
  page, err := client.Embed.Organizations.List(context.TODO(), straddle.EmbedOrganizationListParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", 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"
}
```