Finds establishment by his UUID

Retrieve all information relating to a facility.

The establishment's UUID has been supplied in return for the Authentications API, so please refer to this documentation to use the Establishments API correctly.

A facility consists of a uuid, a name and a teams list. This list will enable you to retrieve the team you want, thanks to the UUID that identifies it in the Tipsi system.

Path Parameters

• uuid uuid required

  Team identifier (UUID v4 format)

Header Parameters

• Authorization string required
  Example: Bearer <TOKEN>

Responses

• 200
• 401
• 404

---

Successful Operation

application/json

• Schema
• Example (from schema)

---

Schema

• uuid uuid

  Establishment identifier (UUID v4 format)

• name string

  Establishment name (edited by the merchant from his Dashboard)

• teams object[]

  Array [

  uuid uuid

  Team identifier (UUID v4 format)

  name string

  Name of the team

  status string

  Possible values: [ACTIVE, INACTIVE]

  Status of the team

  ]

{
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "L'hôtel le continental",
  "teams": [
    {
      "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Cave à vin du continental",
      "status": "ACTIVE"
    }
  ]
}

Not Authorized

Not Found

Loading...