> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.hellotracks.com/llms.txt > Use this file to discover all available pages before exploring further. # Get the company > Returns the key's company: contact details, address, location, settings and teams. Any member of the company may call it. ## OpenAPI ````yaml v1/openapi.json GET /company openapi: 3.1.0 info: title: Hellotracks REST API version: '1' description: >- Plain REST resources over HTTPS, for tools, automations and services. The ht command line is built on it. contact: email: api@hellotracks.com servers: - url: https://api.hellotracks.com/v1 security: - ApiKey: [] tags: - name: Sign-up and sign-in description: >- Create a company or get an API key by an emailed code, without a key; and check which account a key belongs to. - name: Company description: The company the API key belongs to, with its settings and teams. - name: Members description: 'The people in the company: admins, operators and workers.' - name: API keys description: 'The company''s API keys: list, create, revoke and delete.' - name: Jobs description: 'Jobs: work at a location on a date, assigned to a member.' - name: Places description: 'Places: customer sites and other saved locations with a check-in radius.' - name: Zones description: 'Zones: the company''s geofences.' - name: Routing description: Route optimization for one member's day. - name: ETA pages description: >- Live ETA pages (eta.page links) that show a job's recipient when the worker arrives. - name: Maps description: Rendered maps as GeoJSON, and public map share links. - name: Timesheets description: Clock-in and clock-out entries of members, with totals, and editing them. - name: Forms description: >- Form templates, submitted forms, attachments for file and image fields, and forms linked to places and jobs. - name: Alerts description: >- Alert rules (configs) that watch members, places and zones, and the alerts (instances) they raised. - name: Reports description: >- Reports: the newer reporting API (catalog, preview, run, saved) and the older one (types, generate, jobs, uploads, recurring). - name: Webhooks description: URLs Hellotracks calls when jobs, check-ins, clock-ins or alerts happen. paths: /company: get: tags: - Company summary: Get the company description: >- Returns the key's company: contact details, address, location, settings and teams. Any member of the company may call it. operationId: getCompany responses: '200': description: The company. content: application/json: schema: type: object required: - data - error - meta properties: data: type: object properties: company: $ref: '#/components/schemas/Company' error: type: 'null' meta: $ref: '#/components/schemas/Meta' example: data: company: id: c0c0c0 type: company username: c0c0c0 name: Bay Plumbing Co. email: office@example.com phone: +1 415 555 0100 color: '#1e2a3a' address: 1 Market St, San Francisco, CA 94105 city: San Francisco postalCode: '94105' state: CA countryCode: US location: lat: 37.7941 lng: -122.395 ts: 1735689600000 settings: apiEnabled: true workersCreateJobs: true workersEditJob: false workersCreatePlaces: false workersViewPlaces: false workersOptimizeRoute: false workersViewJobCalendar: false assistantEnabled: false tripsEnabled: true jobGroupsEnabled: false snoozeNotifications: false routeCalcIncludeCompany: false etaPageDefaultShowWorkerName: false etaPageDefaultShowMap: false workersEditTrips: false tripsRequireApproval: false workersEditWorkingHours: false workersWebForms: false workersAllowedTrackingOff: false autoCheckins: true teamsConfig: - id: 1 name: North crew working_hours: monday: start: 800 end: 1700 tuesday: start: 800 end: 1700 wednesday: start: 800 end: 1700 thursday: start: 800 end: 1700 friday: start: 800 end: 1700 saturday: start: 0 end: 0 sunday: start: 0 end: 0 source: team route: start_lat: 37.7941 start_lng: -122.395 error: null meta: path: /v1/company method: GET '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' components: schemas: Company: type: object properties: id: type: string description: Company id (6 characters). type: type: string const: company username: type: string name: type: string email: type: string phone: type: string color: type: string address: type: string city: type: string postalCode: type: string state: type: string countryCode: type: string description: Two-letter country code. location: type: object properties: lat: type: number lng: type: number ts: type: integer format: int64 description: ms timestamp settings: $ref: '#/components/schemas/CompanySettings' teamsConfig: type: array description: >- The company's teams (empty unnamed teams left out). Keys inside are snake_case as stored. items: type: object properties: id: type: integer description: Team number. name: type: string working_hours: $ref: '#/components/schemas/MemberWorkingHours' route: type: object description: The team's route start, when set. properties: start_lat: type: number start_lng: type: number Meta: type: object properties: path: type: string description: The request path, without /v1. example: /jobs method: type: string example: GET CompanySettings: type: object description: Company switches. All booleans. properties: apiEnabled: type: boolean description: The company may use the API. workersCreateJobs: type: boolean description: Workers may create jobs in the app. workersEditJob: type: boolean description: Workers may edit their jobs. workersCreatePlaces: type: boolean description: Workers may create places. workersViewPlaces: type: boolean description: Workers see the company's places. workersOptimizeRoute: type: boolean description: Workers may optimize their own route. workersViewJobCalendar: type: boolean description: Workers see the job calendar. assistantEnabled: type: boolean description: The in-app assistant is on. tripsEnabled: type: boolean description: Trips (mileage log) are on. jobGroupsEnabled: type: boolean description: Job groups are on. snoozeNotifications: type: boolean description: Notifications are snoozed. routeCalcIncludeCompany: type: boolean description: Route calculation starts and ends at the company address. etaPageDefaultShowWorkerName: type: boolean description: The ETA page shows the worker's name by default. etaPageDefaultShowMap: type: boolean description: The ETA page shows the map by default. workersEditTrips: type: boolean description: Workers may edit their trips. tripsRequireApproval: type: boolean description: Trips need an admin's approval. workersEditWorkingHours: type: boolean description: Workers may edit their own working hours. workersWebForms: type: boolean description: Workers fill forms on the web. workersAllowedTrackingOff: type: boolean description: Workers may switch tracking off. autoCheckins: type: boolean description: Automatic check-ins at places are on (default true). MemberWorkingHours: type: object description: >- A week of working hours, one window per day, times as HHMM numbers. On write all 7 days are required; send {} to drop the member's own hours and use the team's again. properties: monday: $ref: '#/components/schemas/MemberWorkingHoursDay' tuesday: $ref: '#/components/schemas/MemberWorkingHoursDay' wednesday: $ref: '#/components/schemas/MemberWorkingHoursDay' thursday: $ref: '#/components/schemas/MemberWorkingHoursDay' friday: $ref: '#/components/schemas/MemberWorkingHoursDay' saturday: $ref: '#/components/schemas/MemberWorkingHoursDay' sunday: $ref: '#/components/schemas/MemberWorkingHoursDay' source: type: string enum: - individual - team - default readOnly: true description: Where the hours come from (response only). ErrorEnvelope: type: object properties: data: type: 'null' error: $ref: '#/components/schemas/Error' meta: $ref: '#/components/schemas/Meta' MemberWorkingHoursDay: type: object required: - start - end properties: start: type: integer description: HHMM as a number, e.g. 800 for 08:00, 1730 for 17:30. end: type: integer description: HHMM as a number. Error: type: object required: - code - message properties: code: type: string description: Stable error code for programs. enum: - invalid_request - invalid_format - invalid_data - invalid_api_key - unknown_user - authentication_failed - forbidden - not_found - already_exists - throttled - not_ready - clock_invalid - force_logout - internal_error - unknown_error message: type: string description: Why it failed, for people. responses: Unauthorized: description: The API key is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: data: null error: code: invalid_api_key message: Invalid Hellotracks API key. meta: path: /jobs method: GET Forbidden: description: The key may not do this. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: data: null error: code: forbidden message: No permission. meta: path: /jobs method: GET TooManyRequests: description: Too many requests; slow down. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: data: null error: code: throttled message: Too many requests. meta: path: /jobs method: GET securitySchemes: ApiKey: type: apiKey in: header name: API-Key description: >- Your API key, from More → API & Integrations in the dashboard, or from ht signup / ht auth login. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.