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

Get a single company by id.

The following values are allowed in the includes query parameter:

  • addresses
  • customers
  • domains
  • phones
  • sociallinks
  • all

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": {        "additionalProp": "Unknown Type: any"      },      "type": 0    },    "avatarPath": "string",    "createdAt": "2025-02-11T11:36:38.358Z",    "createdBy": {      "delete": true,      "id": 0,      "meta": {        "additionalProp": "Unknown Type: any"      },
Download Swagger