Skip to content
MediuxDocs

Retrieve a Company

GET/companies/{id}

Returns one Company with its descriptive metadata and Metadata Images.

Path parameters

  • id integer required

    The Company's numeric Mediux ID.

    positive

Responses

200 The Company.

Headers

  • ETag string

    Validator, weak (W/) when the response is compressed. Send it back unchanged as If-None-Match to receive 304.

  • Cache-Control string

    Browser caching policy.

    "public, no-cache"
  • data object
    Show child attributes
    • kind string
      "company"
    • id integer
      positive
    • name string
    • description string | null
    • originCountry string | null
      pattern ^[A-Z]{2}$
    • headquartersCountry string | null
      pattern ^[A-Z]{2}$
    • homepage string | null
    • parentCompany object | null
      Show child attributes
      • id integer
        positive
      • name string
    • metadataImages object
      Show child attributes
      • logo object | null
        Show child attributes
        • id string (uuid)

          Stable image ID, a lowercase UUID. Variant filenames use the same ID.

        • extension string

          Extension of the Original, such as png.

          pattern ^[a-z0-9]{2,5}$
    • movies array of object
      Show item attributes
      • id integer
        positive
      • title string
      • year integer | null
        min 1max 9999
      • poster object | null
        Show child attributes
        • id string (uuid)

          Stable image ID, a lowercase UUID. Variant filenames use the same ID.

        • extension string

          Extension of the Original, such as png.

          pattern ^[a-z0-9]{2,5}$
304 Not modified. The If-None-Match validator still matches; no body.
400 The path is not a valid route, or the request carried a query string or body.

Headers

  • Cache-Control string

    Browser caching policy.

    "no-store"
  • data any | null

    Always null on an error.

  • error object

    Why the request failed.

    Show child attributes
    • code string

      Stable dotted camelCase code such as resource.gone. Branch on this, not on message.

    • message string

      Short explanation for people. Wording can change.

      min length 1max length 256
    • requestId string

      The Cloudflare ray ID. Absent on Snippet and WAF errors and on cached 404, 410 and 503 responses, which carry it only in cf-ray.

      min length 1
    • docs string (uri)

      Link to this code's entry in the error catalogue.

    • details map of string | number | boolean | array of string | null

      Constraints that apply to the failure, such as byte limits, dimensions or allowed types.

    • issues array of object

      Per-field validation failures, when any.

      max 50 items
      Show item attributes
      • code string

        Stable code for this field failure. Branch on this.

        min length 1
      • message string

        Short human-readable description of this field failure.

        min length 1
      • path array of string

        Path to the failing field, for example ["items", 2, "slot"].

      • details map of string | number | boolean | array of string | null

        Constraints that apply to the failure, such as byte limits, dimensions or allowed types.

404 The resource does not exist or is not public.

Headers

  • Cache-Control string

    Browser caching policy.

    "no-store"
  • data any | null

    Always null on an error.

  • error object

    Why the request failed.

    Show child attributes
    • code string

      Stable dotted camelCase code such as resource.gone. Branch on this, not on message.

    • message string

      Short explanation for people. Wording can change.

      min length 1max length 256
    • requestId string

      The Cloudflare ray ID. Absent on Snippet and WAF errors and on cached 404, 410 and 503 responses, which carry it only in cf-ray.

      min length 1
    • docs string (uri)

      Link to this code's entry in the error catalogue.

    • details map of string | number | boolean | array of string | null

      Constraints that apply to the failure, such as byte limits, dimensions or allowed types.

    • issues array of object

      Per-field validation failures, when any.

      max 50 items
      Show item attributes
      • code string

        Stable code for this field failure. Branch on this.

        min length 1
      • message string

        Short human-readable description of this field failure.

        min length 1
      • path array of string

        Path to the failing field, for example ["items", 2, "slot"].

      • details map of string | number | boolean | array of string | null

        Constraints that apply to the failure, such as byte limits, dimensions or allowed types.

405 Only GET, HEAD and OPTIONS are supported.

Headers

  • Cache-Control string

    Browser caching policy.

    "no-store"
  • data any | null

    Always null on an error.

  • error object

    Why the request failed.

    Show child attributes
    • code string

      Stable dotted camelCase code such as resource.gone. Branch on this, not on message.

    • message string

      Short explanation for people. Wording can change.

      min length 1max length 256
    • requestId string

      The Cloudflare ray ID. Absent on Snippet and WAF errors and on cached 404, 410 and 503 responses, which carry it only in cf-ray.

      min length 1
    • docs string (uri)

      Link to this code's entry in the error catalogue.

    • details map of string | number | boolean | array of string | null

      Constraints that apply to the failure, such as byte limits, dimensions or allowed types.

    • issues array of object

      Per-field validation failures, when any.

      max 50 items
      Show item attributes
      • code string

        Stable code for this field failure. Branch on this.

        min length 1
      • message string

        Short human-readable description of this field failure.

        min length 1
      • path array of string

        Path to the failing field, for example ["items", 2, "slot"].

      • details map of string | number | boolean | array of string | null

        Constraints that apply to the failure, such as byte limits, dimensions or allowed types.

429 Too many cache misses from this address. Retry after the Retry-After delay.

Headers

  • Cache-Control string

    Browser caching policy.

    "no-store"
  • Retry-After string

    Seconds to wait before trying again.

    pattern ^\d+$
  • data any | null

    Always null on an error.

  • error object

    Why the request failed.

    Show child attributes
    • code string

      Stable dotted camelCase code such as resource.gone. Branch on this, not on message.

    • message string

      Short explanation for people. Wording can change.

      min length 1max length 256
    • requestId string

      The Cloudflare ray ID. Absent on Snippet and WAF errors and on cached 404, 410 and 503 responses, which carry it only in cf-ray.

      min length 1
    • docs string (uri)

      Link to this code's entry in the error catalogue.

    • details map of string | number | boolean | array of string | null

      Constraints that apply to the failure, such as byte limits, dimensions or allowed types.

    • issues array of object

      Per-field validation failures, when any.

      max 50 items
      Show item attributes
      • code string

        Stable code for this field failure. Branch on this.

        min length 1
      • message string

        Short human-readable description of this field failure.

        min length 1
      • path array of string

        Path to the failing field, for example ["items", 2, "slot"].

      • details map of string | number | boolean | array of string | null

        Constraints that apply to the failure, such as byte limits, dimensions or allowed types.

503 Temporarily unavailable. Retry after the Retry-After delay.

Headers

  • Cache-Control string

    Browser caching policy.

    "no-store"
  • Retry-After string

    Seconds to wait before trying again.

    pattern ^\d+$
  • data any | null

    Always null on an error.

  • error object

    Why the request failed.

    Show child attributes
    • code string

      Stable dotted camelCase code such as resource.gone. Branch on this, not on message.

    • message string

      Short explanation for people. Wording can change.

      min length 1max length 256
    • requestId string

      The Cloudflare ray ID. Absent on Snippet and WAF errors and on cached 404, 410 and 503 responses, which carry it only in cf-ray.

      min length 1
    • docs string (uri)

      Link to this code's entry in the error catalogue.

    • details map of string | number | boolean | array of string | null

      Constraints that apply to the failure, such as byte limits, dimensions or allowed types.

    • issues array of object

      Per-field validation failures, when any.

      max 50 items
      Show item attributes
      • code string

        Stable code for this field failure. Branch on this.

        min length 1
      • message string

        Short human-readable description of this field failure.

        min length 1
      • path array of string

        Path to the failing field, for example ["items", 2, "slot"].

      • details map of string | number | boolean | array of string | null

        Constraints that apply to the failure, such as byte limits, dimensions or allowed types.