List method
A list method is an API operation that retrieves the resources belonging to a specified collection.
API Design Patterns
A list method is a standard API operation that returns the resources belonging to a specified collection.
- How it is used
- Provides collection browsing, including nested resources, filtered subsets, associated resources, and discoverable long-running operations.
- How deep it goes
- Explains targets, access control, filtering, pagination, soft deletion, and operation discovery, while deferring broader listing concerns.
- Examples
- Uses ChatRoom messages, group memberships, Operation resources, and soft-deleted ChatRooms as concrete listing scenarios.
- What you can do after
- Apply via standard API conventions to browse collections, constrain results, respect authorization, and expose selected soft-deleted resources.
Build and Orchestrator in Go (From Scratch)
The store List method returns all tasks in the persistent task store as a slice of task pointers.
- How it is used
- Retrieves all stored tasks when manager APIs need a task collection rather than a task by key.
- How deep it goes
- Works through map iteration and persistent bucket traversal, including JSON decoding and error propagation for the persistent implementation.
- Examples
- Uses an in-memory task map and a BoltDB task bucket to assemble slices of task pointers.
- What you can do after
- Apply it via the Store interface to return all manager tasks without directly accessing the backing map.
Read how Build and Orchestrator in Go (From Scratch) explains list method →
The Design of Web APIs, Second Edition
A list operation is an API operation that retrieves current collections of selectable or related data for an account application.
- How it is used
- Supports consumer access to current collections, selectable data, and narrowly targeted search results.
- How deep it goes
- Explains empty-result semantics, filtering, sorting, pagination, response scope, and summary-versus-detail representations.
- Examples
- Uses transaction queries, account applications, account ownership scopes, and course collection-versus-detail responses.
- What you can do after
- Operate/configure list methods with consumer-oriented query controls, current selectable data, explicit response scope, and safe collection sizing.
Read how The Design of Web APIs, Second Edition explains list method →
What to know first
- HTTP GETHTTP GET is a safe, idempotent HTTP method that requests a representation of a resource without intending to change its state.
- HTTP methodAn HTTP method is a standardized token in an HTTP request that indicates the operation the client intends to perform on a resource.
Related concepts
- filteringused by · Filtering is the selection or exclusion of data or items according to specified criteria.
- paginationuses · Pagination is the technique of dividing a collection or result set into bounded portions that can be retrieved or displayed separately.
- export methodequivalent to · An export method is an interface element that makes data or functionality available to external consumers or systems.
- HTTP GETcontrasts with · HTTP GET is a safe, idempotent HTTP method that requests a representation of a resource without intending to change its state.
- HTTP methodkind of · An HTTP method is a standardized token in an HTTP request that indicates the operation the client intends to perform on a resource.
- OpenAPI specificationconfigured by · The OpenAPI Specification is a machine-readable standard for describing HTTP APIs, including their operations, inputs, outputs, data structures, and security requirements.
Questions about list method
What is list method?
A list method is an API operation that retrieves the resources belonging to a specified collection.
Which Manning books explain list method?
API Design Patterns, Build and Orchestrator in Go (From Scratch) and The Design of Web APIs, Second Edition.
What should I know before learning list method?
Manning books that teach list method usually introduce HTTP GET and HTTP method first.
What is the difference between list method and HTTP GET?
A list method is an API operation that retrieves the resources belonging to a specified collection. HTTP GET is a safe, idempotent HTTP method that requests a representation of a resource without intending to change its state.
What is list method a kind of?
List method is a kind of HTTP method. An HTTP method is a standardized token in an HTTP request that indicates the operation the client intends to perform on a resource.
These guides are generated from the text of Manning books by Manning's knowledge graph and link to the sections they draw on. The full books are available on liveBook and at manning.com.


