Sign in
Pinning

List pinned content

Changed on

Lists all pinned content with optional filtering.

Returns paginated list of pin objects representing content pinned to IPFS. Supports filtering by CID, name, status, metadata, and time range. When no filters are provided, only successfully pinned items are shown.

Use this to:

  • Audit pinned content
  • Search for specific pins
  • Monitor pinning status

See also: POST /pins (add pin), GET /pins/{id} (get pin details)

get/pins

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /pins
  • Auth: none declared

Query parameters

afterstring

Filter for pins created after this ISO 8601 timestamp. Example: 2024-01-01T00:00:00Z

beforestring

Filter for pins created before this ISO 8601 timestamp. Example: 2024-01-01T00:00:00Z

cidstring[]

Filter by content identifier. Supports multiple CIDs for batch queries. Example: QmHash1, QmHash2

limitinteger

Maximum number of records to return. Default: 10, Max: 100

matchstring

Text matching strategy: 'exact' for exact match, 'iexact' for case-insensitive exact match, 'contains' for partial match

metastring

Filter by metadata key-value pairs. Format: JSON string. Example: {"type":"document"}

namestring

Filter by pin name. Supports partial matching for search functionality.

statusstring[]

Filter by pin status: 'queued', 'pinning', 'pinned', 'failed', 'unpinned'. Example: pinned,failed

Response

Successful response

countinteger required

Changes

  • 06e0fa4f446eRevision changes
    • info

      added the non-success response with the status

  • b97dd0465ab3Revision changes
    • breaking

      the response's property type changed from string to object for status

    • breaking

      the response's property type changed from string to object for status

    • breaking

      the response's property type changed from string to object for status

    • breaking

      the response's property type changed from string to object for status

    • breaking

      the response's property type changed from string to object for status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status