Get

GET /v1/company/{id}

Get Company

Path parameters

id string Required

Company id

Responses

200 application/json

successful operation
Hide response attributes Show response attributes object
- id string Required
  
  ID
- name string Required
  
  Name
- slug string Required
  
  Slug
- email string Required
  
  Email
- phone string | null
  
  Phone number
- createdAt string(date-time) | null Required
  
  Created at
- isClassicCustomer boolean Required
  
  Is classic customer
- logo string | null Required
  
  Company logo
- address object Required
  
  Address schema
  
  Hide address attributes Show address attributes object
  
  id string
  
  id
  
  companyId string Required
  
  Company ID
  
  entityId string Required
  
  Entity ID
  
  address1 string | null Required
  
  Address 1
  
  address2 string | null Required
  
  Address 2
  
  town string | null Required
  
  Town
  
  state string | null Required
  
  State
  
  countryCode string | null Required
  
  Country Code
  
  zip string | null Required
  
  Zip
- settings object Required
  
  Company Settings Group schema
  
  Hide settings attributes Show settings attributes object
  
  general object Required
  
  Company General Settings schema
  
  Hide general attributes Show general attributes object
  
  id string | null Required
  
  Company settings ID
  
  timezone string Required
  
  Values are Africa/Abidjan, Africa/Accra, Africa/Addis_Ababa, Africa/Algiers, Africa/Asmara, Africa/Bamako, Africa/Bangui, Africa/Banjul, Africa/Bissau, Africa/Blantyre, Africa/Brazzaville, Africa/Bujumbura, Africa/Cairo, Africa/Casablanca, Africa/Ceuta, Africa/Conakry, Africa/Dakar, Africa/Dar_es_Salaam, Africa/Djibouti, Africa/Douala, Africa/El_Aaiun, Africa/Freetown, Africa/Gaborone, Africa/Harare, Africa/Johannesburg, Africa/Juba, Africa/Kampala, Africa/Khartoum, Africa/Kigali, Africa/Kinshasa, Africa/Lagos, Africa/Libreville, Africa/Lome, Africa/Luanda, Africa/Lubumbashi, Africa/Lusaka, Africa/Malabo, Africa/Maputo, Africa/Maseru, Africa/Mbabane, Africa/Mogadishu, Africa/Monrovia, Africa/Nairobi, Africa/Ndjamena, Africa/Niamey, Africa/Nouakchott, Africa/Ouagadougou, Africa/Porto-Novo, Africa/Sao_Tome, Africa/Tripoli, Africa/Tunis, Africa/Windhoek, America/Adak, America/Anchorage, America/Anguilla, America/Antigua, America/Araguaina, America/Argentina/Buenos_Aires, America/Argentina/Catamarca, America/Argentina/Cordoba, America/Argentina/Jujuy, America/Argentina/La_Rioja, America/Argentina/Mendoza, America/Argentina/Rio_Gallegos, America/Argentina/Salta, America/Argentina/San_Juan, America/Argentina/San_Luis, America/Argentina/Tucuman, America/Argentina/Ushuaia, America/Aruba, America/Asuncion, America/Atikokan, America/Bahia, America/Bahia_Banderas, America/Barbados, America/Belem, America/Belize, America/Blanc-Sablon, America/Boa_Vista, America/Bogota, America/Boise, America/Cambridge_Bay, America/Campo_Grande, America/Cancun, America/Caracas, America/Cayenne, America/Cayman, America/Chicago, America/Chihuahua, America/Ciudad_Juarez, America/Costa_Rica, America/Creston, America/Cuiaba, America/Curacao, America/Danmarkshavn, America/Dawson, America/Dawson_Creek, America/Denver, America/Detroit, America/Dominica, America/Edmonton, America/Eirunepe, America/El_Salvador, America/Fort_Nelson, America/Fortaleza, America/Glace_Bay, America/Goose_Bay, America/Grand_Turk, America/Grenada, America/Guadeloupe, America/Guatemala, America/Guayaquil, America/Guyana, America/Halifax, America/Havana, America/Hermosillo, America/Indiana/Indianapolis, America/Indiana/Knox, America/Indiana/Marengo, America/Indiana/Petersburg, America/Indiana/Tell_City, America/Indiana/Vevay, America/Indiana/Vincennes, America/Indiana/Winamac, America/Inuvik, America/Iqaluit, America/Jamaica, America/Juneau, America/Kentucky/Louisville, America/Kentucky/Monticello, America/Kralendijk, America/La_Paz, America/Lima, America/Los_Angeles, America/Lower_Princes, America/Maceio, America/Managua, America/Manaus, America/Marigot, America/Martinique, America/Matamoros, America/Mazatlan, America/Menominee, America/Merida, America/Metlakatla, America/Mexico_City, America/Miquelon, America/Moncton, America/Monterrey, America/Montevideo, America/Montserrat, America/Nassau, America/New_York, America/Nome, America/Noronha, America/North_Dakota/Beulah, America/North_Dakota/Center, America/North_Dakota/New_Salem, America/Nuuk, America/Ojinaga, America/Panama, America/Paramaribo, America/Phoenix, America/Port-au-Prince, America/Port_of_Spain, America/Porto_Velho, America/Puerto_Rico, America/Punta_Arenas, America/Rankin_Inlet, America/Recife, America/Regina, America/Resolute, America/Rio_Branco, America/Santarem, America/Santiago, America/Santo_Domingo, America/Sao_Paulo, America/Scoresbysund, America/Sitka, America/St_Barthelemy, America/St_Johns, America/St_Kitts, America/St_Lucia, America/St_Thomas, America/St_Vincent, America/Swift_Current, America/Tegucigalpa, America/Thule, America/Tijuana, America/Toronto, America/Tortola, America/Vancouver, America/Whitehorse, America/Winnipeg, America/Yakutat, Antarctica/Casey, Antarctica/Davis, Antarctica/DumontDUrville, Antarctica/Macquarie, Antarctica/Mawson, Antarctica/McMurdo, Antarctica/Palmer, Antarctica/Rothera, Antarctica/Syowa, Antarctica/Troll, Antarctica/Vostok, Arctic/Longyearbyen, Asia/Aden, Asia/Almaty, Asia/Amman, Asia/Anadyr, Asia/Aqtau, Asia/Aqtobe, Asia/Ashgabat, Asia/Atyrau, Asia/Baghdad, Asia/Bahrain, Asia/Baku, Asia/Bangkok, Asia/Barnaul, Asia/Beirut, Asia/Bishkek, Asia/Brunei, Asia/Chita, Asia/Choibalsan, Asia/Colombo, Asia/Damascus, Asia/Dhaka, Asia/Dili, Asia/Dubai, Asia/Dushanbe, Asia/Famagusta, Asia/Gaza, Asia/Hebron, Asia/Ho_Chi_Minh, Asia/Hong_Kong, Asia/Hovd, Asia/Irkutsk, Asia/Jakarta, Asia/Jayapura, Asia/Jerusalem, Asia/Kabul, Asia/Kamchatka, Asia/Karachi, Asia/Kathmandu, Asia/Khandyga, Asia/Kolkata, Asia/Krasnoyarsk, Asia/Kuala_Lumpur, Asia/Kuching, Asia/Kuwait, Asia/Macau, Asia/Magadan, Asia/Makassar, Asia/Manila, Asia/Muscat, Asia/Nicosia, Asia/Novokuznetsk, Asia/Novosibirsk, Asia/Omsk, Asia/Oral, Asia/Phnom_Penh, Asia/Pontianak, Asia/Pyongyang, Asia/Qatar, Asia/Qostanay, Asia/Qyzylorda, Asia/Riyadh, Asia/Sakhalin, Asia/Samarkand, Asia/Seoul, Asia/Shanghai, Asia/Singapore, Asia/Srednekolymsk, Asia/Taipei, Asia/Tashkent, Asia/Tbilisi, Asia/Tehran, Asia/Thimphu, Asia/Tokyo, Asia/Tomsk, Asia/Ulaanbaatar, Asia/Urumqi, Asia/Ust-Nera, Asia/Vientiane, Asia/Vladivostok, Asia/Yakutsk, Asia/Yangon, Asia/Yekaterinburg, Asia/Yerevan, Atlantic/Azores, Atlantic/Bermuda, Atlantic/Canary, Atlantic/Cape_Verde, Atlantic/Faroe, Atlantic/Madeira, Atlantic/Reykjavik, Atlantic/South_Georgia, Atlantic/St_Helena, Atlantic/Stanley, Australia/Adelaide, Australia/Brisbane, Australia/Broken_Hill, Australia/Darwin, Australia/Eucla, Australia/Hobart, Australia/Lindeman, Australia/Lord_Howe, Australia/Melbourne, Australia/Perth, Australia/Sydney, Europe/Amsterdam, Europe/Andorra, Europe/Astrakhan, Europe/Athens, Europe/Belgrade, Europe/Berlin, Europe/Bratislava, Europe/Brussels, Europe/Bucharest, Europe/Budapest, Europe/Busingen, Europe/Chisinau, Europe/Copenhagen, Europe/Dublin, Europe/Gibraltar, Europe/Guernsey, Europe/Helsinki, Europe/Isle_of_Man, Europe/Istanbul, Europe/Jersey, Europe/Kaliningrad, Europe/Kirov, Europe/Kyiv, Europe/Lisbon, Europe/Ljubljana, Europe/London, Europe/Luxembourg, Europe/Madrid, Europe/Malta, Europe/Mariehamn, Europe/Minsk, Europe/Monaco, Europe/Moscow, Europe/Oslo, Europe/Paris, Europe/Podgorica, Europe/Prague, Europe/Riga, Europe/Rome, Europe/Samara, Europe/San_Marino, Europe/Sarajevo, Europe/Saratov, Europe/Simferopol, Europe/Skopje, Europe/Sofia, Europe/Stockholm, Europe/Tallinn, Europe/Tirane, Europe/Ulyanovsk, Europe/Vaduz, Europe/Vatican, Europe/Vienna, Europe/Vilnius, Europe/Volgograd, Europe/Warsaw, Europe/Zagreb, Europe/Zurich, Indian/Antananarivo, Indian/Chagos, Indian/Christmas, Indian/Cocos, Indian/Comoro, Indian/Kerguelen, Indian/Mahe, Indian/Maldives, Indian/Mauritius, Indian/Mayotte, Indian/Reunion, Pacific/Apia, Pacific/Auckland, Pacific/Bougainville, Pacific/Chatham, Pacific/Chuuk, Pacific/Easter, Pacific/Efate, Pacific/Fakaofo, Pacific/Fiji, Pacific/Funafuti, Pacific/Galapagos, Pacific/Gambier, Pacific/Guadalcanal, Pacific/Guam, Pacific/Honolulu, Pacific/Kanton, Pacific/Kiritimati, Pacific/Kosrae, Pacific/Kwajalein, Pacific/Majuro, Pacific/Marquesas, Pacific/Midway, Pacific/Nauru, Pacific/Niue, Pacific/Norfolk, Pacific/Noumea, Pacific/Pago_Pago, Pacific/Palau, Pacific/Pitcairn, Pacific/Pohnpei, Pacific/Port_Moresby, Pacific/Rarotonga, Pacific/Saipan, Pacific/Tahiti, Pacific/Tarawa, Pacific/Tongatapu, Pacific/Wake, Pacific/Wallis, or UTC.
  
  locale string Required
  
  Values are en-IE, en-AU, en-CA, en-GB, en-NZ, en-US, en_AU, en_CA, or en_NZ.
  
  industry string Required
  
  Values are cheer, dance, gymnastics, martial_arts, other, performing_arts, swimming, tennis, or trampolining.
  
  size string Required
  
  Values are not-started-yet, 1-50, 51-100, 101-250, 251-500, or more-than-500.
  
  use12HourClock boolean Required
  
  Use 12 hour clock
  
  brandColor string | null Required
  
  Brand color
  
  brandColors object Required
  
  Full range of brand colors for the company
  
  Hide brandColors attributes Show brandColors attributes object
  
  50 string Required
  
  Hex color code
  
  100 string Required
  
  Hex color code
  
  200 string Required
  
  Hex color code
  
  300 string Required
  
  Hex color code
  
  400 string Required
  
  Hex color code
  
  500 string Required
  
  Hex color code
  
  600 string Required
  
  Hex color code
  
  700 string Required
  
  Hex color code
  
  800 string Required
  
  Hex color code
  
  900 string Required
  
  Hex color code
  
  950 string Required
  
  Hex color code
  
  startDayOfWeek string Required
  
  Values are monday, tuesday, wednesday, thursday, friday, saturday, or sunday.
  
  tax object Required
  
  Company Tax Settings schema
  
  Hide tax attributes Show tax attributes object
  
  id string | null Required
  
  Company tax settings ID
  
  enabled boolean Required
  
  Enabled
  
  taxIdLabel string Required
  
  Tax ID Label
  
  taxIdNumber string | null Required
  
  Tax ID Number
  
  taxMode string Required
  
  Values are inclusive or exclusive.
  
  trial object Required
  
  Company Trial Settings schema
  
  Hide trial attributes Show trial attributes object
  
  id string | null Required
  
  Company trial settings ID
  
  price integer Required
  
  Price
  
  enableOnPortal boolean Required
  
  Enable on portal
  
  maxCapacityPerLesson integer Required
  
  Max capacity per lesson
  
  limitedCapacity boolean Required
  
  Is there a limited capacity for Trials
  
  billing object Required
  
  Company Billing Settings schema
  
  Hide billing attributes Show billing attributes object
  
  id string | null Required
  
  Company billing settings ID
  
  stripeId string | null
  
  Stripe ID
  
  currency string Required
  
  Values are USD, GBP, EUR, CAD, AUD, or NZD.
  
  processingFee number(float) Required
  
  Payment processing fee (percent) with 3 decimal places
  
  isProcessingFeeEnabled boolean Required
  
  Are payment processing fees enabled
  
  billingTiming string Required
  
  Values are advance, during, or arrears.
  
  billingDayOfMonth integer Required
  
  Billing Day of Month (min: 1, max: 28)
  
  enrolment object Required
  
  Company Enrolment Settings schema
  
  Hide enrolment attributes Show enrolment attributes object
  
  id string | null Required
  
  Company enrolment settings ID
  
  ageCutOffType string Required
  
  Type of Age Cut-off to apply
  
  Values are first_day_of_season, days_after_start, or on_specific_date.
  
  ageCutOffDate string | null Required
  
  If Age Cut-off Type is "on_specific_date", this is the date in MM-DD format
  
  ageCutOffDays integer | null Required
  
  If Age Cut-off Type is "days_after_start", this is the number of days
  
  integrations object Required
  
  Company Integration Settings schema
  
  Hide integrations attribute Show integrations attribute object
  
  stripe object Required
  
  Stripe Integration Settings schema
  
  Hide stripe attributes Show stripe attributes object
  
  id string | null Required
  
  Company integration stripe settings ID
  
  connectAccountId string Required
  
  Stripe Connect Account ID
  
  region string Required
  
  Values are us or gb.
  
  feeSchedule string Required
  
  Values are grandfather, standard, or reduced.
  
  payoutStatus string Required
  
  Values are disabled, pending, or enabled.
- countryCode string Required
  
  Company address country code
403 application/json

Not authorized
Hide response attributes Show response attributes object
Error schema
- statusCode number Required
  
  Status Code
- messages array[string] Required
  
  List of error messages
- exception object
  
  Exception
404 application/json

Not found
Hide response attributes Show response attributes object
Error schema
- statusCode number Required
  
  Status Code
- messages array[string] Required
  
  List of error messages
- exception object
  
  Exception

GET /v1/company/{id}

curl \
 --request GET 'https://localhost/v1/company/co_xxxxxxxx'

Response examples (200)

{
  "id": "co_123123123123",
  "name": "My Dance Stdio",
  "slug": "my-dance-studio",
  "email": "john@example.com",
  "phone": "(123) 456 7890",
  "createdAt": "2025-05-04T09:42:00Z",
  "isClassicCustomer": true,
  "logo": "https://example.com/logo.png",
  "address": {
    "id": "loc_xxxxxxxxxxx",
    "companyId": "co_123123123123",
    "entityId": "ent_xxxxxxxxxxx",
    "address1": "123 Main St",
    "address2": "Apt 123",
    "town": "Springfield",
    "state": "IL",
    "countryCode": "US",
    "zip": "12345"
  },
  "settings": {
    "general": {
      "id": "cos_xxxxxxxxxxxxxxxxxxxxxxxxxx",
      "timezone": "Africa/Abidjan",
      "locale": "en-IE",
      "industry": "cheer",
      "size": "not-started-yet",
      "use12HourClock": true,
      "brandColor": "#6354e8",
      "brandColors": {
        "50": "#ffead7",
        "100": "#ffddc1",
        "200": "#ffcfab",
        "300": "#ffc196",
        "400": "#ffad80",
        "500": "#ff9f6a",
        "600": "#ff9154",
        "700": "#ff833e",
        "800": "#ff7528",
        "900": "#ff6712",
        "950": "#ff5a00"
      },
      "startDayOfWeek": "monday"
    },
    "tax": {
      "id": "cotx_xxxxxxxxxxxxxxxxxxxxxxxxxx",
      "enabled": true,
      "taxIdLabel": "Tax ID",
      "taxIdNumber": "123123123",
      "taxMode": "inclusive"
    },
    "trial": {
      "id": "cotr_xxxxxxxxxxxxxxxxxxxxxxxxxx",
      "price": 0,
      "enableOnPortal": true,
      "maxCapacityPerLesson": 0,
      "limitedCapacity": true
    },
    "billing": {
      "id": "cobl_xxxxxxxxxxxxxxxxxxxxxxxxxx",
      "stripeId": "acct_123123123123",
      "currency": "USD",
      "processingFee": 0,
      "isProcessingFeeEnabled": false,
      "billingTiming": "advance",
      "billingDayOfMonth": 13
    },
    "enrolment": {
      "id": "coen_xxxxxxxxxxxxxxxxxxxxxxxxxx",
      "ageCutOffType": "first_day_of_season",
      "ageCutOffDate": "06-24",
      "ageCutOffDays": "7"
    },
    "integrations": {
      "stripe": {
        "id": "coiss_xxxxxxxxxxxxxxxxxxxxxxxxxx",
        "connectAccountId": "acct_123123123",
        "region": "us",
        "feeSchedule": "grandfather",
        "payoutStatus": "disabled"
      }
    }
  },
  "countryCode": "US"
}

Response examples (403)

{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}

Response examples (404)

{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}