← Platform API v1.32.0

GET /platform/tenants/{tenantId}

getPlatformCompany · Platform administration

Active human platform administrator only, rechecked inside the database transaction. No authorization from email or client metadata. Tenant isolation still applies to business records.

Autenticación
SupabaseBearer · http bearer

Ejemplo

Los valores entre <> y {} son marcadores: sustitúyelos por los tuyos antes de ejecutarlo. 

curl --request GET \
  --url 'https://api.marky.ec/v1/platform/tenants/{tenantId}' \
  --header 'Authorization: Bearer <SupabaseBearer>'

Parámetros

Nombre En Tipo Descripción
tenantIdobligatorio path stringformato uuid

Respuestas

200 Success
application/json
PlatformCompanyDetail
objectsin otras propiedades
  • idobligatorio
    stringformato uuid
  • nameobligatorio
    string
  • subscriptionobligatorio
    Cualquiera de
    • objectsin otras propiedades
      • requestedPlanobligatorio
        stringuno de "FREE", "BASIC", "PROFESSIONAL", "ENTERPRISE"
      • effectivePlanobligatorio
        stringuno de "FREE", "BASIC", "PROFESSIONAL", "ENTERPRISE"
      • statusobligatorio
        uno de "ACTIVE", "PENDING_PAYMENT"
      • assignmentTypeobligatorio
        uno de "SELF_SERVICE", "COMPLIMENTARY"
      • versionobligatorio
        integermín. 1
      • assignedByobligatorio
        Cualquiera de
        • stringformato uuid
        • null
      • assignedAtobligatorio
        Cualquiera de
        • stringformato date-time
        • null
      • assignmentReasonobligatorio
        string | nulllongitud máx. 200
      • limitsobligatorio
        objectsin otras propiedades
        • usersobligatorio
          integer | nullmín. 1máx. 100000
        • legalEntitiesobligatorio
          integer | nullmín. 1máx. 100000
        • branchesobligatorio
          integer | nullmín. 1máx. 100000
        • warehousesobligatorio
          integer | nullmín. 1máx. 100000
        • productsobligatorio
          integer | nullmín. 1máx. 100000
    • null
  • usageobligatorio
    objectsin otras propiedades
    • usersobligatorio
      integermín. 0
    • legalEntitiesobligatorio
      integermín. 0
    • branchesobligatorio
      integermín. 0
    • warehousesobligatorio
      integermín. 0
    • productsobligatorio
      integermín. 0
  • historyobligatorio
    arrayelementos máx. 100
    Cada elemento
    objectsin otras propiedades
    • idobligatorio
      stringformato uuid
    • previousPlanobligatorio
      Cualquiera de
      • stringuno de "FREE", "BASIC", "PROFESSIONAL", "ENTERPRISE"
      • null
    • planobligatorio
      stringuno de "FREE", "BASIC", "PROFESSIONAL", "ENTERPRISE"
    • assignedByobligatorio
      stringformato uuid
    • assignedAtobligatorio
      stringformato date-time
    • reasonobligatorio
      string
    • limitsobligatorio
      objectsin otras propiedades
      • usersobligatorio
        integer | nullmín. 1máx. 100000
      • legalEntitiesobligatorio
        integer | nullmín. 1máx. 100000
      • branchesobligatorio
        integer | nullmín. 1máx. 100000
      • warehousesobligatorio
        integer | nullmín. 1máx. 100000
      • productsobligatorio
        integer | nullmín. 1máx. 100000
400 Invalid request, missing global authority, stale version, quota or unavailable service
application/problem+json
ProblemDetails
objectsin otras propiedades
  • typeobligatorio
    valor fijo "about:blank"
  • statusobligatorio
    integer
  • codeobligatorio
    string
  • titleobligatorio
    string
  • detailobligatorio
    string
  • requestIdobligatorio
    stringformato uuid
  • errors
    arrayelementos máx. 200

    Where each problem is, for the codes that can say it: a JSON pointer into the request or the record (`/items/0/devices/1/imei1`) and the reason. A line of a serialized article that is short of units also says how many it bills and how many are identified. Never a value typed by the user, and never an identifier of a unit.

    Cada elemento
    objectsin otras propiedades
    • pointerobligatorio
      string
    • codeobligatorio
      string
    • required
      integermín. 0máx. 1000

      For a line short of units (UNITS_DIFFER_FROM_QUANTITY, RECEIPT_REQUIRED, DELIVERY_REQUIRED): how many units the line bills.

    • identified
      integermín. 0máx. 1000

      For the same line: how many units are identified and linked to it. Given to every reader of the document; no IMEI or serial number is.

401 Invalid request, missing global authority, stale version, quota or unavailable service
application/problem+json
ProblemDetails
objectsin otras propiedades
  • typeobligatorio
    valor fijo "about:blank"
  • statusobligatorio
    integer
  • codeobligatorio
    string
  • titleobligatorio
    string
  • detailobligatorio
    string
  • requestIdobligatorio
    stringformato uuid
  • errors
    arrayelementos máx. 200

    Where each problem is, for the codes that can say it: a JSON pointer into the request or the record (`/items/0/devices/1/imei1`) and the reason. A line of a serialized article that is short of units also says how many it bills and how many are identified. Never a value typed by the user, and never an identifier of a unit.

    Cada elemento
    objectsin otras propiedades
    • pointerobligatorio
      string
    • codeobligatorio
      string
    • required
      integermín. 0máx. 1000

      For a line short of units (UNITS_DIFFER_FROM_QUANTITY, RECEIPT_REQUIRED, DELIVERY_REQUIRED): how many units the line bills.

    • identified
      integermín. 0máx. 1000

      For the same line: how many units are identified and linked to it. Given to every reader of the document; no IMEI or serial number is.

403 Invalid request, missing global authority, stale version, quota or unavailable service
application/problem+json
ProblemDetails
objectsin otras propiedades
  • typeobligatorio
    valor fijo "about:blank"
  • statusobligatorio
    integer
  • codeobligatorio
    string
  • titleobligatorio
    string
  • detailobligatorio
    string
  • requestIdobligatorio
    stringformato uuid
  • errors
    arrayelementos máx. 200

    Where each problem is, for the codes that can say it: a JSON pointer into the request or the record (`/items/0/devices/1/imei1`) and the reason. A line of a serialized article that is short of units also says how many it bills and how many are identified. Never a value typed by the user, and never an identifier of a unit.

    Cada elemento
    objectsin otras propiedades
    • pointerobligatorio
      string
    • codeobligatorio
      string
    • required
      integermín. 0máx. 1000

      For a line short of units (UNITS_DIFFER_FROM_QUANTITY, RECEIPT_REQUIRED, DELIVERY_REQUIRED): how many units the line bills.

    • identified
      integermín. 0máx. 1000

      For the same line: how many units are identified and linked to it. Given to every reader of the document; no IMEI or serial number is.

404 Invalid request, missing global authority, stale version, quota or unavailable service
application/problem+json
ProblemDetails
objectsin otras propiedades
  • typeobligatorio
    valor fijo "about:blank"
  • statusobligatorio
    integer
  • codeobligatorio
    string
  • titleobligatorio
    string
  • detailobligatorio
    string
  • requestIdobligatorio
    stringformato uuid
  • errors
    arrayelementos máx. 200

    Where each problem is, for the codes that can say it: a JSON pointer into the request or the record (`/items/0/devices/1/imei1`) and the reason. A line of a serialized article that is short of units also says how many it bills and how many are identified. Never a value typed by the user, and never an identifier of a unit.

    Cada elemento
    objectsin otras propiedades
    • pointerobligatorio
      string
    • codeobligatorio
      string
    • required
      integermín. 0máx. 1000

      For a line short of units (UNITS_DIFFER_FROM_QUANTITY, RECEIPT_REQUIRED, DELIVERY_REQUIRED): how many units the line bills.

    • identified
      integermín. 0máx. 1000

      For the same line: how many units are identified and linked to it. Given to every reader of the document; no IMEI or serial number is.

409 Invalid request, missing global authority, stale version, quota or unavailable service
application/problem+json
ProblemDetails
objectsin otras propiedades
  • typeobligatorio
    valor fijo "about:blank"
  • statusobligatorio
    integer
  • codeobligatorio
    string
  • titleobligatorio
    string
  • detailobligatorio
    string
  • requestIdobligatorio
    stringformato uuid
  • errors
    arrayelementos máx. 200

    Where each problem is, for the codes that can say it: a JSON pointer into the request or the record (`/items/0/devices/1/imei1`) and the reason. A line of a serialized article that is short of units also says how many it bills and how many are identified. Never a value typed by the user, and never an identifier of a unit.

    Cada elemento
    objectsin otras propiedades
    • pointerobligatorio
      string
    • codeobligatorio
      string
    • required
      integermín. 0máx. 1000

      For a line short of units (UNITS_DIFFER_FROM_QUANTITY, RECEIPT_REQUIRED, DELIVERY_REQUIRED): how many units the line bills.

    • identified
      integermín. 0máx. 1000

      For the same line: how many units are identified and linked to it. Given to every reader of the document; no IMEI or serial number is.

429 Invalid request, missing global authority, stale version, quota or unavailable service
application/problem+json
ProblemDetails
objectsin otras propiedades
  • typeobligatorio
    valor fijo "about:blank"
  • statusobligatorio
    integer
  • codeobligatorio
    string
  • titleobligatorio
    string
  • detailobligatorio
    string
  • requestIdobligatorio
    stringformato uuid
  • errors
    arrayelementos máx. 200

    Where each problem is, for the codes that can say it: a JSON pointer into the request or the record (`/items/0/devices/1/imei1`) and the reason. A line of a serialized article that is short of units also says how many it bills and how many are identified. Never a value typed by the user, and never an identifier of a unit.

    Cada elemento
    objectsin otras propiedades
    • pointerobligatorio
      string
    • codeobligatorio
      string
    • required
      integermín. 0máx. 1000

      For a line short of units (UNITS_DIFFER_FROM_QUANTITY, RECEIPT_REQUIRED, DELIVERY_REQUIRED): how many units the line bills.

    • identified
      integermín. 0máx. 1000

      For the same line: how many units are identified and linked to it. Given to every reader of the document; no IMEI or serial number is.

503 Invalid request, missing global authority, stale version, quota or unavailable service
application/problem+json
ProblemDetails
objectsin otras propiedades
  • typeobligatorio
    valor fijo "about:blank"
  • statusobligatorio
    integer
  • codeobligatorio
    string
  • titleobligatorio
    string
  • detailobligatorio
    string
  • requestIdobligatorio
    stringformato uuid
  • errors
    arrayelementos máx. 200

    Where each problem is, for the codes that can say it: a JSON pointer into the request or the record (`/items/0/devices/1/imei1`) and the reason. A line of a serialized article that is short of units also says how many it bills and how many are identified. Never a value typed by the user, and never an identifier of a unit.

    Cada elemento
    objectsin otras propiedades
    • pointerobligatorio
      string
    • codeobligatorio
      string
    • required
      integermín. 0máx. 1000

      For a line short of units (UNITS_DIFFER_FROM_QUANTITY, RECEIPT_REQUIRED, DELIVERY_REQUIRED): how many units the line bills.

    • identified
      integermín. 0máx. 1000

      For the same line: how many units are identified and linked to it. Given to every reader of the document; no IMEI or serial number is.