establishment

Get an establishment.

Arguments

accountNumber : String

The account number to search establishments for.

siret : String

The SIRET of the establishment searched.

Returns

EstablishmentType

A single Establishment.

Possible Errors

Allowed Viewers

Customer

Partner User

Third party

Required Permissions

Can query establishments

Query Complexity

Examples

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

query Establishment(
  $accountNumber: String,
  $siret: String
) {
  establishment(
    accountNumber: $accountNumber,
    siret: $siret
  ) {
    accounts {
      ...AccountConnectionTypeConnectionFragment
    }
    details {
      ...EstablishmentDetailTypeFragment
    }
    id
    siret
  }
}

{
  "accountNumber": "A-C894EEB0",
  "siret": "many-upon-bring-page-animal"
}

{
  "data": {
    "establishment": {
      "accounts": AccountConnectionTypeConnection,
      "details": [EstablishmentDetailType],
      "id": "16075515",
      "siret": "bill-ahead-argue-something-benefit"
    }
  }
}