Get subsidiary

GET

api

{version}

subsidiaries

{id}

Get subsidiary

curl --request GET \
  --url https://integrations.alvys.com/api/p/v{version}/subsidiaries/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://integrations.alvys.com/api/p/v{version}/subsidiaries/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://integrations.alvys.com/api/p/v{version}/subsidiaries/{id}"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://integrations.alvys.com/api/p/v{version}/subsidiaries/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://integrations.alvys.com/api/p/v{version}/subsidiaries/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "Id": "<string>",
  "Name": "<string>",
  "Type": "<string>",
  "McNumber": "<string>",
  "DotNumber": "<string>",
  "DefaultEquipmentType": "<string>",
  "RemitAddress": {
    "Street": "<string>",
    "City": "<string>",
    "State": "<string>",
    "ZipCode": "<string>",
    "Country": "<string>"
  }
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

Returns a single subsidiary of your own company by id. Use List subsidiaries when you do not already have the id.

This endpoint requires the subsidiary:read scope. It is not part of any other scope, and credentials issued before it existed do not carry it — grant it to the client before your first call. See Authentication.

A subsidiary outside your credential’s subsidiary scope answers 404, identically to one that does not exist. This is deliberate: a scoped credential cannot use this endpoint to discover which subsidiaries exist that it may not read.

Endpoint

GET /api/p/v{version}/subsidiaries/{id}

Request Parameters

Parameter	Type	Required	Description
version	string	Yes	API version to use (`1.0`).
id	string	Yes	Unique identifier of the subsidiary.
includeDeleted	boolean	No	Return the subsidiary even if soft-deleted. Defaults to `false`.

Example CURL request

curl --location 'https://integrations.alvys.com/api/p/v1/subsidiaries/9d4b1327-2774-d32c-fb33-87a288c2722c' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response Fields

Field	Type	Description
Id	string	Unique identifier of the subsidiary.
Name	string	Name of the subsidiary.
Type	string	Either `Carrier` or `Brokerage`.
McNumber	string	MC number of the subsidiary. Omitted when none is recorded.
DotNumber	string	DOT number of the subsidiary. Omitted when none is recorded.
DefaultEquipmentType	string	Default equipment type for the subsidiary.
RemitAddress	Object	Postal remit-to address. Postal fields only — no contact details.
RemitAddress.Street	string	Street line of the remit address.
RemitAddress.City	string	City of the remit address.
RemitAddress.State	string	State or province of the remit address.
RemitAddress.ZipCode	string	Postal code of the remit address.
RemitAddress.Country	string	Country of the remit address. Publishes `US`, `CA` or `MX` for recognized spellings of those countries, otherwise the value exactly as recorded. Omitted when no country is recorded, which must not be read as the United States.

Example Response

200 OK

{
  "Id": "9d4b1327-2774-d32c-fb33-87a288c2722c",
  "Name": "Alvy's Motor",
  "Type": "Carrier",
  "McNumber": "1234567",
  "DotNumber": "2515539",
  "DefaultEquipmentType": "Van",
  "RemitAddress": {
    "Street": "201 Lomas Santa Fe Dr",
    "City": "Solana Beach",
    "State": "CA",
    "ZipCode": "92075",
    "Country": "US"
  }
}

Status Codes

Status	Description
200	Subsidiary returned.
401	Missing or invalid access token.
403	Token lacks the `subsidiary:read` scope.
404	Subsidiary not found, or outside your credential’s subsidiary scope.
429	Rate limit exceeded.

Rate Limits

All endpoints are subject to rate limits to protect the API from traffic spikes. See Rate Limits.

Authorizations

Authorization

string

header

required

OAuth 2.0 client-credentials access token. Obtain one from https://auth.alvys.com/oauth/token (grant_type=client_credentials, audience=https://api.alvys.com/public/), then paste it here. The playground sends it as Authorization: Bearer <token>.

Path Parameters

string

required

version

string

default:1.0

required

API version (e.g., 1.0)

Example:

"1.0"

Query Parameters

includeDeleted

boolean

default:false

Response

string

required

Name

string

required

Type

string

required

McNumber

string | null

DotNumber

string | null

DefaultEquipmentType

string | null

RemitAddress

object | null

Show child attributes

Get subsidiary

curl --request GET \
  --url https://integrations.alvys.com/api/p/v{version}/subsidiaries/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://integrations.alvys.com/api/p/v{version}/subsidiaries/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://integrations.alvys.com/api/p/v{version}/subsidiaries/{id}"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://integrations.alvys.com/api/p/v{version}/subsidiaries/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://integrations.alvys.com/api/p/v{version}/subsidiaries/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "Id": "<string>",
  "Name": "<string>",
  "Type": "<string>",
  "McNumber": "<string>",
  "DotNumber": "<string>",
  "DefaultEquipmentType": "<string>",
  "RemitAddress": {
    "Street": "<string>",
    "City": "<string>",
    "State": "<string>",
    "ZipCode": "<string>",
    "Country": "<string>"
  }
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

​Endpoint

​Request Parameters

​Example CURL request

​Response Fields

​Example Response

​Status Codes

​Rate Limits

Authorizations

Path Parameters

Query Parameters

Response

Endpoint

Request Parameters

Example CURL request

Response Fields

Example Response

Status Codes

Rate Limits