## List representatives

`$ straddle embed:representatives list`

**get** `/v1/representatives`

Returns a list of representatives associated with a specific account or organization. The representatives are returned sorted by creation date, with the most recently created representatives appearing first. This endpoint supports advanced sorting and filtering options.

### Parameters

- `--account-id: optional string`

  Query param: The unique identifier of the account to list representatives for.

- `--level: optional "account" or "platform"`

  Query param

- `--organization-id: optional string`

  Query param

- `--page-number: optional number`

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

- `--page-size: optional number`

  Query param: Page size. Max value: 1000

- `--platform-id: optional string`

  Query param

- `--sort-by: optional string`

  Query param: Sort By.

- `--sort-order: optional "asc" or "desc"`

  Query param: Sort Order.

- `--correlation-id: optional string`

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

- `--request-id: optional string`

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

### Returns

- `representativePaged: object { data, meta, response_type }`

  - `data: array of object { id, account_id, created_at, 15 more }`

    - `id: string`

      Unique identifier for the representative.

    - `account_id: string`

      The unique identifier of the account this representative is associated with.

    - `created_at: string`

      Timestamp of when the representative was created.

    - `dob: string`

      The date of birth of the representative, in ISO 8601 format (YYYY-MM-DD).

    - `email: string`

      The email address of the representative.

    - `first_name: string`

      The first name of the representative.

    - `last_name: string`

      The last name of the representative.

    - `mobile_number: string`

      The mobile phone number of the representative.

    - `name: string`

    - `relationship: object { control, owner, primary, 2 more }`

      - `control: boolean`

        Whether the representative has significant responsibility to control, manage, or direct the organization. One representative must be identified under the control prong for each legal entity.

      - `owner: boolean`

        Whether the representative owns any percentage of of the equity interests of the legal entity.

      - `primary: boolean`

        Whether the person is authorized as the primary representative of the account. This is the person chosen by the business to provide information about themselves, general information about the account, and who consented to the services agreement.

        There can be only one primary representative for an account at a time.

      - `percent_ownership: optional number`

        The percentage of ownership the representative has. Required if 'Owner' is true.

      - `title: optional string`

        The job title of the representative.

    - `ssn_last4: string`

      The last 4 digits of the representative's Social Security Number.

    - `status: "created" or "onboarding" or "active" or 2 more`

      The current status of the representative.

      - `"created"`

      - `"onboarding"`

      - `"active"`

      - `"rejected"`

      - `"inactive"`

    - `status_detail: object { code, message, reason, source }`

      - `code: string`

        A machine-readable code for the specific status, useful for programmatic handling.

      - `message: string`

        A human-readable message describing the current status.

      - `reason: "unverified" or "in_review" or "pending" or 5 more`

        A machine-readable identifier for the specific status, useful for programmatic handling.

        - `"unverified"`

        - `"in_review"`

        - `"pending"`

        - `"stuck"`

        - `"verified"`

        - `"failed_verification"`

        - `"disabled"`

        - `"new"`

      - `source: "watchtower"`

        Identifies the origin of the status change (e.g., `watchtower`). This helps in tracking the cause of status updates.

        - `"watchtower"`

    - `updated_at: string`

      Timestamp of the most recent update to the representative.

    - `external_id: optional string`

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

    - `metadata: optional map[string]`

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

    - `phone: optional string`

    - `user_id: optional string`

      The unique identifier of the user account associated with this representative, if applicable.

  - `meta: object { api_request_id, api_request_timestamp, max_page_size, 6 more }`

    Metadata about the API request, including an identifier, timestamp, and pagination details.

    - `api_request_id: string`

      Unique identifier for this API request, useful for troubleshooting.

    - `api_request_timestamp: string`

      Timestamp for this API request, useful for troubleshooting.

    - `max_page_size: number`

      Maximum allowed page size for this endpoint.

    - `page_number: number`

      Page number for paginated results.

    - `page_size: number`

      Number of items per page in this response.

    - `sort_by: string`

      The field that the results were sorted by.

    - `sort_order: "asc" or "desc"`

      - `"asc"`

      - `"desc"`

    - `total_items: number`

      Total number of items returned in this response.

    - `total_pages: number`

      The number of pages available.

  - `response_type: "object" or "array" or "error" or "none"`

    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.

    - `"object"`

    - `"array"`

    - `"error"`

    - `"none"`

### Example

```cli
straddle embed:representatives list \
  --api-key 'My API Key'
```

#### Response

```json
{
  "data": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "created_at": "2019-12-27T18:11:19.117Z",
      "dob": "1980-01-01",
      "email": "ron.swanson@pawnee.com",
      "first_name": "Ron",
      "last_name": "Swanson",
      "mobile_number": "+12128675309",
      "name": "name",
      "relationship": {
        "control": true,
        "owner": true,
        "primary": true,
        "percent_ownership": 0,
        "title": "title"
      },
      "ssn_last4": "1234",
      "status": "created",
      "status_detail": {
        "code": "code",
        "message": "message",
        "reason": "unverified",
        "source": "watchtower"
      },
      "updated_at": "2019-12-27T18:11:19.117Z",
      "external_id": "external_id",
      "metadata": {
        "foo": "string"
      },
      "phone": "phone",
      "user_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
    }
  ],
  "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"
}
```