GET
/
partner
/
v1
/
companies
/
List Companies
curl --request GET \
  --url https://api.paywise.de/partner/v1/companies/ \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "href": "https://api.paywise.de/partner/v1/companies/e2f8f69c-d5ef-4821-b334-d3b5769f9a70/",
      "id": "6196ba03-83f2-46ea-83e1-a087bd0c5acc",
      "name": "Mustermann GmbH & Co. KG",
      "address": {
        "street": "Musterstr. 1",
        "zip": "44651",
        "city": "Musterhausen",
        "country": "DE"
      },
      "phone": "+49 89 123456",
      "vat_number": "DE123456789",
      "users": [
        {
          "href": "https://api.paywise.de/partner/v1/users/ab5fc850-7bb3-4c33-9741-d1305dfa41d9/",
          "id": "ab5fc850-7bb3-4c33-9741-d1305dfa41d9",
          "email": "[email protected]",
          "first_name": "Max",
          "last_name": "Mustermann",
          "company": "6196ba03-83f2-46ea-83e1-a087bd0c5acc",
          "email_verified": true,
          "notification_channels": [
            {
              "channel_type": "EMAIL",
              "value": "[email protected]",
              "notification_types": [
                "REQUESTS_TO_CLIENT",
                "STATUS_UPDATE",
                "STATEMENTS"
              ]
            }
          ]
        }
      ],
      "data_submission_completed": true,
      "legal_form": "GmbH & Co. KG",
      "legal_representatives": [
        {
          "type": "komplementaer",
          "name": "Mustermann Holding GbnH"
        },
        {
          "type": "geschaeftsführer",
          "name": "Max Mustermann"
        }
      ],
      "tax_deduction_eligibility": "J",
      "notification_channels": [
        {
          "channel_type": "EMAIL",
          "value": "[email protected]",
          "notification_types": [
            "REQUESTS_TO_CLIENT",
            "STATUS_UPDATE",
            "STATEMENTS"
          ]
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
id
string<uuid>
​
limit
integer

Number of results to return per page.

​
name
string
​
offset
integer

The initial index from which to return the results.

Response

200 - application/json
​
count
integer
Example:

123

​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=400&limit=100"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=200&limit=100"

​
results
object[]