# Pins

## List pins

`client.pins.list(PinListParamsparams, RequestOptionsoptions?): PinListResponse`

**get** `/pins`

Returns a paginated list of pins for the authenticated company.
Results are ordered by creation date (newest first).

### Parameters

- `params: PinListParams`

  - `rotorAPIVersion: "1.1.0"`

    Header param: Required OpenAPI version header.

    - `"1.1.0"`

  - `limit?: number`

    Query param: Number of results per page (max 1000)

  - `page?: number`

    Query param: Page number (1-based)

  - `pin_type_id?: string`

    Query param: Filter pins by pin type

  - `user_id?: string`

    Query param: Filter pins by the user who created them

### Returns

- `PinListResponse`

  - `data?: Array<Data>`

    - `id: string`

    - `created_at: string`

    - `created_by: CreatedBy`

      - `email: string`

      - `name: string`

      - `user_id: string`

    - `location: Array<number>`

      Geographic coordinates [latitude, longitude]

    - `pin_type: PinType`

      - `id: string`

      - `color: string`

        Hex color code for the pin

      - `label: string`

        Display label for the pin type

  - `pagination?: Pagination`

    - `has_more?: boolean`

      Whether more pages are available

    - `limit?: number`

    - `page?: number`

    - `total?: number`

      Total number of matching records

  - `status?: string`

### Example

```typescript
import Rotor from 'getrotor';

const client = new Rotor({
  rotorAPIVersion: '1.1.0',
  apiKey: process.env['ROTOR_API_KEY'], // This is the default and can be omitted
});

const pins = await client.pins.list({ 'rotor-api-version': '1.1.0' });

console.log(pins.data);
```

#### Response

```json
{
  "data": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by": {
        "email": "dev@stainless.com",
        "name": "name",
        "user_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
      },
      "location": [
        40.7128,
        -74.006
      ],
      "pin_type": {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "color": "#FF0000",
        "label": "High Priority"
      }
    }
  ],
  "pagination": {
    "has_more": true,
    "limit": 50,
    "page": 1,
    "total": 142
  },
  "status": "success"
}
```