Skip to main content
GET
/
v1
/
administrations
Get administrations
curl --request GET \
  --url https://api.paytsoftware.com/v1/administrations \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "email_address": "<string>",
      "contact_name": "<string>",
      "commercial_registration_number": "<string>",
      "country_code": "<string>",
      "city": "<string>",
      "house_number": "<string>",
      "internal_name": "<string>",
      "street_name": "<string>",
      "postal_code": "<string>",
      "bank_account_name": "<string>",
      "bank_account_number": "<string>",
      "bank_account_bic": "<string>",
      "vat_number": "<string>",
      "timezone": "<string>",
      "currency_code": "<string>",
      "administration_url": "<string>",
      "paused_at": "2023-11-07T05:31:56Z",
      "reminding_paused_at": "2023-11-07T05:31:56Z",
      "import_origin_identifier": "<string>",
      "last_successful_import_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "cursor": "<string>"
  }
}

Authorizations

Authorization
string
header
required

OAuth2 access token or static API token. See Authorization for how to obtain one.

Query Parameters

fields
object

JSON object defining fields to receive (e.g {"only": ["field1", {"field2": ["field3"]}]})

cursor
string

The record identifier after which to start the page

per_page
integer<int32>
default:100

How many records will be returned per page, (1..500), defaults to 100

Required range: 1 <= x <= 500

Response

Paginated list of administrations

CustomerApi_AdministrationsPageEntity model

data
object[]
required

Administration

pagination
object

Pagination details

Last modified on June 12, 2026