> ## 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 a map share > Returns the share's details without its GeoJSON (the public apiUrl has the snapshot). Revoked and expired shares are returned with revoked/expired set. An unknown token gives 400 (invalid_request). Workers are refused with 403 (code permission_denied). ## OpenAPI ````yaml v1/openapi.json GET /maps/shares/{token} 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: /maps/shares/{token}: get: tags: - Maps summary: Get a map share description: >- Returns the share's details without its GeoJSON (the public apiUrl has the snapshot). Revoked and expired shares are returned with revoked/expired set. An unknown token gives 400 (invalid_request). Workers are refused with 403 (code permission_denied). operationId: getMapShare parameters: - name: token in: path required: true schema: type: string example: map_abcdefghijk234567mnop2 description: Share token (map_...). responses: '200': description: Success content: application/json: schema: type: object required: - data - error - meta properties: data: type: object required: - share properties: share: $ref: '#/components/schemas/MapShare' error: type: 'null' meta: $ref: '#/components/schemas/Meta' example: data: share: id: map_abcdefghijk234567mnop2 token: map_abcdefghijk234567mnop2 url: >- https://live.hellotracks.com/share/maps/map_abcdefghijk234567mnop2 apiUrl: >- https://api.hellotracks.com/api/share/maps/map_abcdefghijk234567mnop2 title: Hellotracks places kind: places source: public_api companyId: c1d2e3 companyName: Example Plumbing createdById: c1d2e3 createdByName: Example Plumbing createdAt: 1793520000000 expiresAt: 1794124800000 revokedAt: 0 expired: false revoked: false featureCount: 2 hasMore: false aborted: false spec: kind: places layers: - kind: places id: places title: Hellotracks places featureCount: 2 hasMore: false aborted: false layers: - kind: places id: places title: Hellotracks places featureCount: 2 hasMore: false aborted: false bounds: minLng: -122.4194 minLat: 37.7749 maxLng: -122.3937 maxLat: 37.7955 error: null meta: path: /v1/maps/shares/{token} method: GET '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/ServerError' components: schemas: MapShare: type: object properties: id: type: string description: 'Same as token: map_ followed by 18 characters.' token: type: string url: type: string format: uri description: Public link, no API key needed. apiUrl: type: string format: uri description: Public JSON of the share including its GeoJSON snapshot. title: type: string kind: type: string source: type: string companyId: type: string companyName: type: string createdById: type: string createdByName: type: string createdAt: type: integer format: int64 expiresAt: type: integer format: int64 revokedAt: type: integer format: int64 expired: type: boolean revoked: type: boolean featureCount: type: integer hasMore: type: boolean aborted: type: boolean spec: type: object additionalProperties: true layers: type: array items: type: object additionalProperties: true bounds: type: object properties: minLng: type: number minLat: type: number maxLng: type: number maxLat: type: number example: id: map_abcdefghijk234567mnop2 token: map_abcdefghijk234567mnop2 url: https://live.hellotracks.com/share/maps/map_abcdefghijk234567mnop2 apiUrl: https://api.hellotracks.com/api/share/maps/map_abcdefghijk234567mnop2 title: Hellotracks places kind: places source: public_api companyId: c1d2e3 companyName: Example Plumbing createdById: c1d2e3 createdByName: Example Plumbing createdAt: 1793520000000 expiresAt: 1794124800000 revokedAt: 0 expired: false revoked: false featureCount: 2 hasMore: false aborted: false spec: kind: places layers: - kind: places id: places title: Hellotracks places featureCount: 2 hasMore: false aborted: false layers: - kind: places id: places title: Hellotracks places featureCount: 2 hasMore: false aborted: false bounds: minLng: -122.4194 minLat: 37.7749 maxLng: -122.3937 maxLat: 37.7955 Meta: type: object properties: path: type: string description: The request path, without /v1. example: /jobs method: type: string example: GET ErrorEnvelope: type: object properties: data: type: 'null' error: $ref: '#/components/schemas/Error' meta: $ref: '#/components/schemas/Meta' 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: BadRequest: description: The request is invalid. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: data: null error: code: invalid_request message: date must be YYYY-MM-DD meta: path: /jobs method: GET 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 ServerError: description: Hellotracks failed; retry later. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: data: null error: code: internal_error message: Hellotracks API is temporarily unavailable. 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.