Get by ID | Chrt

import { ChrtClient, ChrtEnvironment } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        environment: ChrtEnvironment.Local,
        token: "YOUR_TOKEN_HERE",
    });
    await client.directoryEntries.getV1("directory_entry_id");
}
main();

{
  "schema_version": 1,
  "created_by_org_id": "org_9f8b7c6d5e4a3b2c1d0e",
  "created_by_user_id": "user_abcdef1234567890",
  "_id": "direntry_9876543210fedcba",
  "entry_org_id": "org_9f8b7c6d5e4a3b2c1d0e",
  "entry_off_chrt_shipper_org_id": "shipper_1234567890abcdef",
  "company_name": "Global Freight Solutions",
  "industry": "Logistics and Transportation",
  "location": {
    "type": "Feature",
    "geometry": {
      "bbox": [
        -122.4194,
        37.7749,
        -122.414,
        37.779
      ],
      "type": "Point",
      "coordinates": [
        -122.4167,
        37.7775
      ]
    },
    "bbox": [
      -122.4194,
      37.7749,
      -122.414,
      37.779
    ],
    "properties": {
      "address": "123 Market St, San Francisco, CA 94103",
      "name": "Global Freight Warehouse"
    },
    "id": "loc_001"
  },
  "contact_first_name": "Emily",
  "contact_last_name": "Johnson",
  "phone_number_primary": "+1-415-555-1234",
  "phone_number_secondary": "+1-415-555-5678",
  "email_address_primary": "emily.johnson@globalfreight.com",
  "email_address_secondary": "support@globalfreight.com",
  "job_title": "Operations Manager",
  "notes": "Primary contact for shipment coordination and scheduling."
}

Retrieves a specific directory entry by ID if authorized to access it. | authz: min_org_role=operator | () -> (DirectoryEntry1)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

directory_entry_idstringRequired

Response

Successful Response

schema_versioninteger

created_by_org_idstring

Must be a string starting with org_

created_by_user_idstring

Must be a string starting with user_

_idstring

entry_org_idstring or null

entry_off_chrt_shipper_org_idstring or null

company_namestring or null

industrystring or null

locationobject or null

GeoJSON Feature with typed properties for locations

The geometry field is strongly typed as Geometry (union of all geometry types) but remains optional to match the base Feature class specification. To ensure geometry is always present, validate it at runtime or make it required.

contact_first_namestring or null

contact_last_namestring or null

phone_number_primarystring or nullformat: "phone"

phone_number_secondarystring or nullformat: "phone"

email_address_primarystring or null

email_address_secondarystring or null

job_titlestring or null

notesstring or null

Authentication

Path parameters

Response

Errors