v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Provider Configurations API

List Provider Configurations

Use this endpoint to retrieve a paginated list of provider configurations. You can filter results by status or provider ID.

get/v1/provider-configurations

Query parameters

status'active' | 'disabled'

Filter results by status.

providerIdstring

Filter results by a specific provider ID.

limitinteger

Maximum number of items to return per page. Defaults to 10. Must be between 1 and 100.

cursorstring

Cursor for pagination. Use the value from the nextCursor field in a previous response to retrieve the next page.

sortBy'createdAt' | 'updatedAt' | 'name'

Field to sort results by.

sortOrder'ASC' | 'DESC'

Sort direction. Use ASC for ascending or DESC for descending.

Response

Indicates that the request was successful and the response contains the requested data.

hasMoreboolean

Indicates whether more pages are available.

nextCursorstring

Cursor for the next page.

Example response

{
  "items": [
    {
      "id": "c3d4e5f6-a7b8-9012-cdef-345678901234",
      "name": "ClearSale Production",
      "description": "ClearSale anti-fraud for Pix transactions",
      "providerId": "clearsale",
      "config": {
        "baseUrl": "https://api.clearsale.com.br"
      },
      "status": "active",
      "createdAt": "2026-03-17T14:00:00Z",
      "updatedAt": "2026-03-17T14:00:00Z"
    }
  ],
  "nextCursor": "",
  "hasMore": false
}