API references
Search documentation... ⌘K
API references
Open merchant dashboard
Merchant API
All our references

List all metadata stored for your merchant account. Results are paginated.

Endpoint signature
This endpoint requires an API key. Read our authentication guide for more information.
POST https://api.reservepay.com/merchants/list-metadata HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer <token>
{
per_page: number?,
after: string?,
before: string?,
}
Returns: object
New to Reservepay? Read our guide on how to call endpoints to get started. Note that this endpoint returns a paginated response, see the Pagination section of the same guide.
Request arguments
per_page number

Optional. Number of metadata records to return per page (default: 25)

after string

Optional. Cursor for pagination - return metadata created after this record UID

before string

Optional. Cursor for pagination - return metadata created before this record UID

Response attributes
Attribute Description
uid
string

The unique identifier (UID) for the metadata record.
key
string

The unique key for the metadata.
metadata
object

The stored JSON metadata.
bytesize
number

The size of the metadata in bytes.
version
number

The current version number (lock_version).
updated_at
number

The Unix timestamp (seconds since epoch) when the metadata was last updated.
created_at
number

The Unix timestamp (seconds since epoch) when the metadata was created.
expires_at
number

The Unix timestamp (seconds since epoch) when the metadata will expire. May be null.
Errors common to all endpoints
UNHANDLED_ERROR

This error occurs when the server encounters an unexpected internal error that it cannot handle gracefully. This typically happens due to bugs, infrastructure issues, or edge cases that weren't anticipated during development.

INVALID_ARGUMENTS

This error occurs when the request contains invalid or missing parameters. Common cases include missing required fields, or values that don't match the expected format or type.

BAD_VERSION

This error occurs when making requests to an API version that does not exist. This commonly happens when using an outdated SDK or when the API version specified in the request URL is incorrect.

CODE SAMPLES
curl
Learn how to run these code samples in your terminal by reading our guide.