Pins

List pins

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

GET

/pins

List pins

curl --request GET \
  --url 'https://api.getrotor.com/open-api/pins?page=1&limit=50&user_id=550e8400-e29b-41d4-a716-446655440000&pin_type_id=550e8400-e29b-41d4-a716-446655440001' \
  --header 'x-api-key: <api-key>' \
  --header 'rotor-api-version: 1.1.0'

{
  "data": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": {
        "email": "jsmith@example.com",
        "name": "<string>",
        "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "location": [
        40.7128,
        -74.006
      ],
      "pin_type": {
        "color": "#FF0000",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "label": "High Priority"
      }
    }
  ],
  "pagination": {
    "has_more": true,
    "limit": 50,
    "page": 1,
    "total": 142
  },
  "status": "success"
}

Authorizations

x-api-keystringheaderrequired

Company API key in the format: rotor_{keyId}_{keySecret}

To obtain an API key:

Log into your Rotor dashboard
Go to Settings → Integrations → API Keys
Create a new key and select the scopes you need
Copy the key — it's only shown once!

Query Parameters

pageintegerquerydefault:1

Page number (1-based)

Required range: 1 <= x

Example: 1

limitintegerquerydefault:50

Number of results per page (max 1000)

Required range: 1 <= x <= 1000

Example: 50

user_idstringquery

Filter pins by the user who created them

Example: 550e8400-e29b-41d4-a716-446655440000

pin_type_idstringquery

Filter pins by pin type

Example: 550e8400-e29b-41d4-a716-446655440001

Headers

rotor-api-versionenum<string>headerdefault:1.1.0required

Required OpenAPI version header.

Available options: 1.1.0

Example: 1.1.0

Response

Pins listed successfully

dataobject[]

Show child attributes

paginationobject

Show child attributes

statusstring

Example: success

Still need help? Ask the team