> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.getply.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.getply.com/_mcp/server.

# List Pick Lists

GET https://api.getply.com/api/v1/pick-lists

Returns a paginated list of pick lists for the authenticated business.
Optionally filter by status. Invalid status values return `400` with a
list of valid values.

Requires scope: `pick_lists:read`

Reference: https://docs.getply.com/api-reference/api-reference/pick-lists/list

## Authentication

- `API_KEY` header (required) — API Key authentication via header

## Servers

- `https://api.getply.com` (production, default)
- `https://sandbox-api.getply.com` (sandbox)

## Request

### Query parameters

- `page` (integer, optional) — Zero-based page index. Defaults to `0`.
- `size` (integer, optional) — Items per page. Defaults to `20`, maximum `100`.
- `status` (enum, optional) — Filter by status. Returns `400` with a list of valid values if an unrecognized status is provided.
  - Allowed values: `NEED_REFILL`, `ASSEMBLED`, `WAITING`, `COMPLETED`, `ARCHIVED`
- `sort` (string, optional) — Sort by `field,direction` (Spring Pageable format; direction `asc` or `desc`, default `asc`). Allowed fields: id, name, note, status, requestDate, createdAt, updatedAt. Default order (when no sort is supplied): `createdAt,desc`.

## Response

### 200

- `data` (list of PickList, required)
- `pagination` (PaginationMeta, required) — Pagination metadata returned on all list endpoints.

## Errors

### 400 Bad Request Error

The request was malformed or failed validation. Check the `message` field for details on which fields are invalid.

- `code` (string, required) — Machine-readable error code (e.g. `NOT_FOUND`, `VALIDATION_ERROR`).
- `message` (string, required) — Human-readable description of what went wrong.
- `status` (integer, required) — HTTP status code.
- `timestamp` (string, required) — ISO 8601 timestamp when the error occurred (e.g. `2026-03-20T14:30:00`).
- `path` (string, required) — The request path that triggered the error.

### 401 Unauthorized Error

The `API_KEY` header is missing or the key is invalid. Verify your API key in the Ply dashboard under Settings > Workspace > API Keys.

- `code` (string, required) — Machine-readable error code (e.g. `NOT_FOUND`, `VALIDATION_ERROR`).
- `message` (string, required) — Human-readable description of what went wrong.
- `status` (integer, required) — HTTP status code.
- `timestamp` (string, required) — ISO 8601 timestamp when the error occurred (e.g. `2026-03-20T14:30:00`).
- `path` (string, required) — The request path that triggered the error.

### 403 Forbidden Error

The authenticated API key does not have permission to perform this action.

- `code` (string, required) — Machine-readable error code (e.g. `NOT_FOUND`, `VALIDATION_ERROR`).
- `message` (string, required) — Human-readable description of what went wrong.
- `status` (integer, required) — HTTP status code.
- `timestamp` (string, required) — ISO 8601 timestamp when the error occurred (e.g. `2026-03-20T14:30:00`).
- `path` (string, required) — The request path that triggered the error.

### 429 Rate Limit Error

You have exceeded the rate limit. Two limits apply, both pooled per business — creating additional API keys does not raise either: - 60 requests per minute - 10,000 requests per day Any response that passes authentication carries `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset`; requests rejected earlier, such as a missing key or a missing scope, carry none of them. On a `429`, wait the number of seconds given in `Retry-After` before retrying, and back off further if you get a second one.

- `code` (string, required) — Machine-readable error code (e.g. `NOT_FOUND`, `VALIDATION_ERROR`).
- `message` (string, required) — Human-readable description of what went wrong.
- `status` (integer, required) — HTTP status code.
- `timestamp` (string, required) — ISO 8601 timestamp when the error occurred (e.g. `2026-03-20T14:30:00`).
- `path` (string, required) — The request path that triggered the error.

## Types

### PickList

A list of materials to be transferred between locations for a job or field request.

- `id` (UUID, required) — Unique identifier for the pick list.
- `name` (string, required) — Display name of the pick list.
- `materialCount` (long, required) — Number of distinct material line items in this pick list.
- `kitCount` (long, required) — Number of kit line items in this pick list.
- `createdAt` (datetime, required) — ISO 8601 timestamp when the record was created.
- `updatedAt` (datetime, required) — ISO 8601 timestamp when the record was last updated.
- `note` (string, optional) — Optional note or description for this pick list.
- `status` (enum, optional) — Current status of the pick list.
  - Allowed values: `NEED_REFILL`, `ASSEMBLED`, `WAITING`, `COMPLETED`, `ARCHIVED`
- `fromLocation` (PickListLocationSummary, optional) — Source location materials are picked from. `null` when the pick list has no source location, in which case adding a material requires `materialDetailsId`.
- `toLocation` (PickListLocationSummary, optional) — Destination location materials are transferred to.
- `requestDate` (date, optional) — Requested date for the pick (ISO 8601 date, e.g. `2026-03-25`).

### PaginationMeta

Pagination metadata returned on all list endpoints.

- `page` (integer, required) — Zero-based page index of the current result set.
- `size` (integer, required) — Number of items per page actually applied — the page's capacity, not the number of rows it happens to contain, so a final partial page still reports the full size. When you supply a valid `size` this is that value, because requests above the maximum are rejected rather than reduced: a truncated page can never be reported as a full one. When you omit `size` it is the default of 20.
- `totalElements` (long, required) — Total number of items matching the query across all pages.
- `totalPages` (integer, required) — Total number of pages available.

### PickListLocationSummary

A summary of a location referenced in a pick list.

- `id` (UUID, required) — Unique identifier for the location.
- `name` (string, required) — Display name of the location.
- `type` (enum, required) — Location type.
  - Allowed values: `TRUCK`, `WAREHOUSE`, `JOB`

## Examples

**Response**

```json
{
  "data": [
    {
      "id": "c5d6e7f8-a9b0-1234-cdef-567890123456",
      "name": "Job #1204 - Phase 2 Materials",
      "materialCount": 3,
      "kitCount": 0,
      "createdAt": "2026-03-20T09:00:00",
      "updatedAt": "2026-03-20T09:00:00",
      "note": null,
      "status": "NEED_REFILL",
      "fromLocation": {
        "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
        "name": "Main Warehouse",
        "type": "WAREHOUSE"
      },
      "toLocation": {
        "id": "d4e5f6a7-b8c9-0123-defa-456789012345",
        "name": "Job #1204 Site",
        "type": "JOB"
      },
      "requestDate": "2026-03-25"
    }
  ],
  "pagination": {
    "page": 0,
    "size": 20,
    "totalElements": 1,
    "totalPages": 1
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.getply.com/api/v1/pick-lists"

headers = {"API_KEY": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.getply.com/api/v1/pick-lists';
const options = {method: 'GET', headers: {API_KEY: '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getply.com/api/v1/pick-lists"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("API_KEY", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.getply.com/api/v1/pick-lists")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["API_KEY"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.getply.com/api/v1/pick-lists")
  .header("API_KEY", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.getply.com/api/v1/pick-lists', [
  'headers' => [
    'API_KEY' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.getply.com/api/v1/pick-lists");
var request = new RestRequest(Method.GET);
request.AddHeader("API_KEY", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["API_KEY": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.getply.com/api/v1/pick-lists")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```