Skip to main content

List terminal themes

get/companies/{companyId}/terminalThemes

Returns a paginated list of terminal themes for the company specified in the path and all the associated merchant accounts. The response provides only the metadata of the themes. Assets (images and videos) are not included. To obtain the URLs for the assets of a specific theme, make a GET request to the /companies/{companyId}/terminalThemes/{id} endpoint.

To make this request, your API credential must have the following role:

  • Management API - Terminal themes read and write
Endpoint destination URL
https://management-test.adyen.com/v3/companies/{companyId}/terminalThemes
Click to copy
searchstring

A search term to filter themes by name. The match is case-insensitive and returns any theme with a name that contains the search term.

pageinteger
Minimum: 1Maximum: 10000

The number of the page to fetch. If not specified, the list starts from page 1.

pageSizeinteger
Minimum: 1Maximum: 100

The number of themes to return per page. If not specified, the list has 10 themes per page.

companyIdstringRequired

The unique identifier of the company account.

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • 200

    OK

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Not Found

  • 422

    Unprocessable Entity

  • 500

    Internal Server Error