For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
GithubSign up
DocsCouriersShippersForwardersTrackersAppAPI ReferenceSDKsFAQ
DocsCouriersShippersForwardersTrackersAppAPI ReferenceSDKsFAQ
  • API Reference
      • GETGet info
      • GETList members
      • POSTSet up org
      • GETGet Stripe Connect Account ID
LogoLogo
GithubSign up
API ReferenceOrgs

Get info

GET
/orgs/info/v1
GET
/orgs/info/v1
1import { ChrtClient } from "@chrt-inc/typescript-sdk";
2
3async function main() {
4 const client = new ChrtClient({
5 token: "YOUR_TOKEN_HERE",
6 });
7 await client.orgs.getInfoV1();
8}
9main();
200Retrieved
1{
2 "id": "org_9f8b7c6d5e4a3b2c1d0e",
3 "name": "Chrt Logistics",
4 "public_metadata": {
5 "industry": "Transportation",
6 "headquarters": "San Francisco, CA",
7 "founded_year": 2012
8 },
9 "slug": "chrt-logistics",
10 "image_url": "https://cdn.chrt.com/orgs/chrt-logistics/logo.png",
11 "has_image": true,
12 "members_count": 125,
13 "max_allowed_memberships": 500,
14 "admin_delete_enabled": true,
15 "created_at": 1684502400,
16 "updated_at": 1716038400
17}

Retrieves basic organization information from the authentication service. | () -> (OrgInfoResponse)

Was this page helpful?

List members

Next
Built with

Authentication

AuthorizationBearer

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

Response

Successful Response
idstring

Must be a string starting with org_

namestring
public_metadatamap from strings to any
slugstring
image_urlstring
has_imagebooleanDefaults to false
members_countinteger
max_allowed_membershipsintegerDefaults to 0
admin_delete_enabledbooleanDefaults to false
created_atinteger
updated_atinteger