Finds company by id. To call this, you need to have access contact details right of 090300.

curl -X GET "https://api.example.com/restapi/v1/companies/123" \
  -H "Content-Type: application/json"

import requests
import json

url = "https://api.example.com/restapi/v1/companies/123"
headers = {
  "Content-Type": "application/json"
}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch("https://api.example.com/restapi/v1/companies/123", {
  method: "GET",
  headers: {
  "Content-Type": "application/json"
}
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
)

func main() {

    req, err := http.NewRequest("GET", "https://api.example.com/restapi/v1/companies/123", nil)
    if err != nil {
        panic(err)
    }

    req.Header.Set("Content-Type", "application/json")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    fmt.Println("Response Status:", resp.Status)
}

require 'net/http'
require 'json'

uri = URI('https://api.example.com/restapi/v1/companies/123')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'

response = http.request(request)
puts response.body

[
  {
    "id": 123,
    "name": "John Doe",
    "name2": "John Doe",
    "contactCategoriesId": [
      123
    ],
    "email": "user@example.com",
    "defaultAddress": [
      {
        "id": 123,
        "addressType": 42,
        "parentContact": "example_string",
        "parentContactId": 123,
        "isDefault": true,
        "position": "example_string",
        "department": "example_string",
        "street": "example_string",
        "houseNumber": "example_string",
        "addition": "example_string",
        "zip": "example_string",
        "city": "New York",
        "state": "example_string",
        "country": "USA",
        "emails": [
          {
            "id": 123,
            "email": "user@example.com"
          }
        ],
        "phones": [
          {
            "id": 123,
            "type": "example_string",
            "countryCode": "USA",
            "areaCode": "example_string",
            "number": "example_string"
          }
        ]
      }
    ],
    "defaultPhone": {
      "id": 123,
      "type": "example_string",
      "countryCode": "USA",
      "areaCode": "example_string",
      "number": "example_string"
    },
    "defaultFax": {
      "id": 123,
      "type": "example_string",
      "countryCode": "USA",
      "areaCode": "example_string",
      "number": "example_string"
    },
    "defaultMobile": {
      "id": 123,
      "type": "example_string",
      "countryCode": "USA",
      "areaCode": "example_string",
      "number": "example_string"
    },
    "allAddress": [
      {
        "id": 123,
        "addressType": 42,
        "parentContact": "example_string",
        "parentContactId": 123,
        "isDefault": true,
        "position": "example_string",
        "department": "example_string",
        "street": "example_string",
        "houseNumber": "example_string",
        "addition": "example_string",
        "zip": "example_string",
        "city": "New York",
        "state": "example_string",
        "country": "USA",
        "emails": [
          {
            "id": 123,
            "email": "user@example.com"
          }
        ],
        "phones": [
          {
            "id": 123,
            "type": "example_string",
            "countryCode": "USA",
            "areaCode": "example_string",
            "number": "example_string"
          }
        ]
      }
    ]
  }
]

{
  "error": "Bad Request",
  "message": "The request contains invalid parameters or malformed data",
  "code": 400,
  "details": [
    {
      "field": "email",
      "message": "Invalid email format"
    }
  ]
}

GET

/companies/{companyId}

GET

Base URLstring

Target server for requests. Edit to use your own host.

path

companyIdinteger

Required

ID of company to return

Request Preview

Response

Response will appear here after sending the request

Path Parameters

companyIdinteger

Required

ID of company to return

Responses

idinteger

namestring

name2string

contactCategoriesIdinteger[]

emailstring

defaultAddressarray

defaultPhoneobject

defaultFaxobject

defaultMobileobject

allAddressarray

Was this page helpful?

[ { "id": 123, "name": "John Doe", "name2": "John Doe", "contactCategoriesId": [ 123 ], "email": "user@example.com", "defaultAddress": [ { "id": 123, "addressType": 42, "parentContact": "example_string", "parentContactId": 123, "isDefault": true, "position": "example_string", "department": "example_string", "street": "example_string", "houseNumber": "example_string", "addition": "example_string", "zip": "example_string", "city": "New York", "state": "example_string", "country": "USA", "emails": [ { "id": 123, "email": "user@example.com" } ], "phones": [ { "id": 123, "type": "example_string", "countryCode": "USA", "areaCode": "example_string", "number": "example_string" } ] } ], "defaultPhone": { "id": 123, "type": "example_string", "countryCode": "USA", "areaCode": "example_string", "number": "example_string" }, "defaultFax": { "id": 123, "type": "example_string", "countryCode": "USA", "areaCode": "example_string", "number": "example_string" }, "defaultMobile": { "id": 123, "type": "example_string", "countryCode": "USA", "areaCode": "example_string", "number": "example_string" }, "allAddress": [ { "id": 123, "addressType": 42, "parentContact": "example_string", "parentContactId": 123, "isDefault": true, "position": "example_string", "department": "example_string", "street": "example_string", "houseNumber": "example_string", "addition": "example_string", "zip": "example_string", "city": "New York", "state": "example_string", "country": "USA", "emails": [ { "id": 123, "email": "user@example.com" } ], "phones": [ { "id": 123, "type": "example_string", "countryCode": "USA", "areaCode": "example_string", "number": "example_string" } ] } ] } ]