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

List metadata

Returns a paginated list of all metadata records stored for your merchant account.

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
previous
object

Nullable. Cursor for the previous page. Contains 'before' (ID) and 'per_page' (page size) parameters. Use these values in the 'before' and 'per_page' parameters of the next request to get the previous page.
page
array<object.metadata>

Always present. The current page of records, ordered by creation date (newest first).
next
object

Nullable. Cursor for the next page. Contains 'after' (ID) and 'per_page' (page size) parameters. Use these values in the 'after' and 'per_page' parameters of the next request to get the next page.
Metadata attributes
Attribute Description
key
string

Always present. The unique key that identifies the metadata object.
metadata
any

Nullable. The stored JSON metadata.
bytesize
number

Always present. The size of the metadata in bytes.
version
number

Always present. The current version number (lock_version).
updated_at
number

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

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

Nullable. 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.

Open in Markdown
CODE SAMPLES
curl
curl "https://api.reservepay.com/merchants/list-metadata" \
  -X POST
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $(RESERVEPAY_API_KEY)" \
  -d '{}'
Learn how to run these code samples in your terminal by reading our guide.