GET/desk/api/v2/companies/{id}.json

Get a single company by id.

Path Params

  • Name
    id
    Type
    integer
    required
    Description

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    CompanyAPIBody is the request/response format for the API
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    Validator hold the validation errors. Typically you shouldn't create this directly but use the New() function.
  • Code
    404
    Type
    object
    Schema
    Description
    404 Not Found
    Error represents an occurrence of an error in the API.

Examples

200 OK

CompanyAPIBody
{  "company": {    "address": {      "delete": true,      "id": 0,      "meta": {},      "type": 0    },    "avatarPath": "string",    "createdAt": "2024-07-22T17:45:09.733Z",    "createdBy": {      "delete": true,      "id": 0,      "meta": {},      "type": 0    },    "customers": [      {