Lister les propriétaires du tenant (vue liste, sans IBAN)

GET

/v1/owners

const url = 'https://example.com/v1/owners';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/v1/owners \
  --header 'X-API-Key: <X-API-Key>'

Authorizations

ApiKeyAuth
BearerAuth

Responses

200

Propriétaires (triés par nom)

application/json

object

data

required

Array<object>

object

required

string format: uuid

code

required

string

name

required

string

ownerType

required

string

Allowed values: individual company

vatRegime

required

string

status

required

string

createdAt

required

string format: date-time

Example

{
  "data": [
    {
      "ownerType": "individual"
    }
  ]
}

401

Non authentifié

application/json

object

code

required

Code machine de l’erreur

string

message

required

Message lisible

string

origin

Origine domaine de l’erreur (optionnel)

object

boundedContext

string

module

string

status

required

integer

traceId

required

Identifiant de corrélation pour le support

string

Example

{
  "code": "RESERVATION_NOT_FOUND",
  "message": "Réservation introuvable",
  "status": 404
}

403

Permission refusée (owner.read)

application/json

object

code

required

Code machine de l’erreur

string

message

required

Message lisible

string

origin

Origine domaine de l’erreur (optionnel)

object

boundedContext

string

module

string

status

required

integer

traceId

required

Identifiant de corrélation pour le support

string

Example

{
  "code": "RESERVATION_NOT_FOUND",
  "message": "Réservation introuvable",
  "status": 404
}