--- title: "Get a company" method: GET path: "/companies/v1/company" tags: ["Companies"] --- # Get a company `GET /companies/v1/company` Retrieves a contractor company by its ID, including compliance statistics. ## Query parameters - `company_type_id` string - `company_id` string, required - `include_compliance_stats` boolean - `include_user_credential_compliance_stats` boolean ## Response `200` A successful response. - S12ContractorsV1GetContractorCompanyResponse - `contractor_company` S12ContractorsV1ContractorCompany — A contractor company. - `company_id` string — The ID of the company. - `attributes` S12ContractorsV1ContractorCompanyAttributes — Intrinsic attributes associated with a contractor company. - `name` string — The name of the company. - `contact_details` S12ContractorsV1CompanyContactDetails — Contact details associated with a contractor company. - `email` string — The email address of the company. - `phone_number` string — The phone number of the company. - `address` S12ContractorsV1Address - `sub_premise` string — A first-order entity below a named location eg. Building, floor level, or suite - `street_number` string — Street number - `street` string — Street name - `city` string — City or locality - `administrative_area_level_2` string — deprecated. For output, this will return the value of administrative_area_level for backward compatibility. - `administrative_area_level_1` string — A first-order civil entity below the country level. These do not exist in all countries. eg. within the United States: state or province, within the UK: county, within Australia: state - `postal_code` string — Postal code - `country_code` string — Country code (ISO 3166-1 alpha-2) - `image` S12CommonMedia - `id` string - `token` string - `filename` string — full file name, including file extension - `media_type` 'MEDIA_TYPE_IMAGE' | 'MEDIA_TYPE_VIDEO' | 'MEDIA_TYPE_PDF' | 'MEDIA_TYPE_DOCX' | 'MEDIA_TYPE_XLSX' | 'MEDIA_TYPE_PPTX' | 'MEDIA_TYPE_CSV' — - MEDIA_TYPE_IMAGE: An image file (GIF, JPG, PNG, WEBP). - MEDIA_TYPE_VIDEO: A video file (MP4, MOV). - MEDIA_TYPE_PDF: A PDF document. - MEDIA_TYPE_DOCX: A Microsoft Word document (DOCX, DOC). - MEDIA_TYPE_XLSX: A Microsoft Excel spreadsheet (XLSX, XLS). - MEDIA_TYPE_PPTX: A Microsoft PowerPoint presentation (PPTX, PPT). - MEDIA_TYPE_CSV: A CSV file. - `external_reference_id` string — An optional external reference ID for the company that is used in external systems. Enforces uniqueness. - `status` 'CONTRACTOR_COMPANY_STATUS_ACTIVE' | 'CONTRACTOR_COMPANY_STATUS_PENDING' | 'CONTRACTOR_COMPANY_STATUS_DEACTIVATED' — The status of a contractor company. - CONTRACTOR_COMPANY_STATUS_ACTIVE: The company is active. - CONTRACTOR_COMPANY_STATUS_PENDING: The company is pending approval. - CONTRACTOR_COMPANY_STATUS_DEACTIVATED: The company is deactivated. - `compliance_statistics` S12ContractorsV1CompanyComplianceStatistics — CompanyComplianceStatistics is a message that contains statistics about a contractor company's compliance. - `expired_document_count` integer — The number of company documents that have expired. - `expiring_soon_document_count` integer — The number of company documents that are expiring soon. The service hard-codes "expiring soon" as documents that are expiring within the next 30 days. - `pending_approval_document_count` integer — The number of company documents that are pending approval. - `user_credential_compliance_statistics` S12ContractorsV1CompanyUserCredentialComplianceStatistics — CompanyUserCredentialComplianceStatistics is a message that contains statistics about a contractor company's users' credential compliance. - `expired_user_credential_count` integer — The number of user credentials that have expired. - `expiring_soon_user_credential_count` integer — The number of user credentials that are expiring soon. - `pending_approval_user_credential_count` integer — The number of user credentials that are pending approval. - `total_user_credential_count` integer — The total number of user credentials. - `notes` string — An internal note about the company, visible only to users with admin:companies permission. - `site_ids` string[] — The IDs of the sites to associate with this company. On create: links all provided sites to the new company. On update: replaces the full set of site associations (include in update_mask to apply). - `linked_sites` S12ContractorsV1ContractorCompanyLinkedSite[] — The sites currently linked to this company, including resolved site names. Populated on read responses only; to modify the site associations use site_ids. - `site_id` string — The ID of the linked site. - `site_name` string — The display name of the linked site. - `metadata` S12ContractorsV1ContractorCompanyMetadata — Metadata associated with a contractor company. - `created_by_user` S12ContractorsV1User — Information about a SafetyCulture user. - `id` string — The ID of the user. - `first_name` string — The first name of the user. - `last_name` string — The last name of the user. - `created_at` string, date-time — The creation date of the company - `last_modified_by_user` S12ContractorsV1User — Information about a SafetyCulture user. - `id` string — The ID of the user. - `first_name` string — The first name of the user. - `last_name` string — The last name of the user. - `last_modified` string, date-time — The last modified date of the company - `created_by_user_doc` S12CommonUserDocument - `id` string — UUID of the user - `email` string — Email of the user - `first_name` string — First name of the user - `last_name` string — Last name of the user - `timezone` string — What timezone the user is in - `profile_picture` string — URL of the profile picture of the user - `status` 'USER_ACTIVE_STATUS_UNSPECIFIED' | 'USER_ACTIVE_STATUS_ACTIVE' | 'USER_ACTIVE_STATUS_DEACTIVATED' — - USER_ACTIVE_STATUS_UNSPECIFIED: Status is unknown or not specified - USER_ACTIVE_STATUS_ACTIVE: User is active - USER_ACTIVE_STATUS_DEACTIVATED: User has been deactivated - `external_mappings` S12CommonUserDocumentUserExternalMappings - `edapp_id` string - `seat_type` 'SUBSCRIPTION_SEAT_TYPE_UNSPECIFIED' | 'SUBSCRIPTION_SEAT_TYPE_PREMIUM' | 'SUBSCRIPTION_SEAT_TYPE_COLLABORATOR' | 'SUBSCRIPTION_SEAT_TYPE_LITE' | 'SUBSCRIPTION_SEAT_TYPE_SERVICE_USER' | 'SUBSCRIPTION_SEAT_TYPE_SUPPORT' - `profile_image` S12CommonMedia - `id` string - `token` string - `filename` string — full file name, including file extension - `media_type` 'MEDIA_TYPE_IMAGE' | 'MEDIA_TYPE_VIDEO' | 'MEDIA_TYPE_PDF' | 'MEDIA_TYPE_DOCX' | 'MEDIA_TYPE_XLSX' | 'MEDIA_TYPE_PPTX' | 'MEDIA_TYPE_CSV' — - MEDIA_TYPE_IMAGE: An image file (GIF, JPG, PNG, WEBP). - MEDIA_TYPE_VIDEO: A video file (MP4, MOV). - MEDIA_TYPE_PDF: A PDF document. - MEDIA_TYPE_DOCX: A Microsoft Word document (DOCX, DOC). - MEDIA_TYPE_XLSX: A Microsoft Excel spreadsheet (XLSX, XLS). - MEDIA_TYPE_PPTX: A Microsoft PowerPoint presentation (PPTX, PPT). - MEDIA_TYPE_CSV: A CSV file. - `last_seen` string, date-time — Timestamp of when the user last interacted with the system. May be empty. - `email_confirmed` boolean — Whether or not the user has confirmed their email. - `created_at` string, date-time — Timestamp of when the user was created. - `language` 'LANGUAGE_UNSPECIFIED' | 'LANGUAGE_EN_US' | 'LANGUAGE_EN_GB' | 'LANGUAGE_DE_DE' | 'LANGUAGE_ES_ES' | 'LANGUAGE_FR_FR' | 'LANGUAGE_PT_BR' | 'LANGUAGE_NL_NL' — - LANGUAGE_UNSPECIFIED: Language unspecified - LANGUAGE_EN_US: Language en-US - LANGUAGE_EN_GB: Language en-GB - LANGUAGE_DE_DE: Language de-DE - LANGUAGE_ES_ES: Language es-ES - LANGUAGE_FR_FR: Language fr-FR - LANGUAGE_PT_BR: Language pt-BR - LANGUAGE_NL_NL: Language nl-NL - `phone_number` string — Phone number of the user - `last_modified_by_user_doc` S12CommonUserDocument - `id` string — UUID of the user - `email` string — Email of the user - `first_name` string — First name of the user - `last_name` string — Last name of the user - `timezone` string — What timezone the user is in - `profile_picture` string — URL of the profile picture of the user - `status` 'USER_ACTIVE_STATUS_UNSPECIFIED' | 'USER_ACTIVE_STATUS_ACTIVE' | 'USER_ACTIVE_STATUS_DEACTIVATED' — - USER_ACTIVE_STATUS_UNSPECIFIED: Status is unknown or not specified - USER_ACTIVE_STATUS_ACTIVE: User is active - USER_ACTIVE_STATUS_DEACTIVATED: User has been deactivated - `external_mappings` S12CommonUserDocumentUserExternalMappings - `edapp_id` string - `seat_type` 'SUBSCRIPTION_SEAT_TYPE_UNSPECIFIED' | 'SUBSCRIPTION_SEAT_TYPE_PREMIUM' | 'SUBSCRIPTION_SEAT_TYPE_COLLABORATOR' | 'SUBSCRIPTION_SEAT_TYPE_LITE' | 'SUBSCRIPTION_SEAT_TYPE_SERVICE_USER' | 'SUBSCRIPTION_SEAT_TYPE_SUPPORT' - `profile_image` S12CommonMedia - `id` string - `token` string - `filename` string — full file name, including file extension - `media_type` 'MEDIA_TYPE_IMAGE' | 'MEDIA_TYPE_VIDEO' | 'MEDIA_TYPE_PDF' | 'MEDIA_TYPE_DOCX' | 'MEDIA_TYPE_XLSX' | 'MEDIA_TYPE_PPTX' | 'MEDIA_TYPE_CSV' — - MEDIA_TYPE_IMAGE: An image file (GIF, JPG, PNG, WEBP). - MEDIA_TYPE_VIDEO: A video file (MP4, MOV). - MEDIA_TYPE_PDF: A PDF document. - MEDIA_TYPE_DOCX: A Microsoft Word document (DOCX, DOC). - MEDIA_TYPE_XLSX: A Microsoft Excel spreadsheet (XLSX, XLS). - MEDIA_TYPE_PPTX: A Microsoft PowerPoint presentation (PPTX, PPT). - MEDIA_TYPE_CSV: A CSV file. - `last_seen` string, date-time — Timestamp of when the user last interacted with the system. May be empty. - `email_confirmed` boolean — Whether or not the user has confirmed their email. - `created_at` string, date-time — Timestamp of when the user was created. - `language` 'LANGUAGE_UNSPECIFIED' | 'LANGUAGE_EN_US' | 'LANGUAGE_EN_GB' | 'LANGUAGE_DE_DE' | 'LANGUAGE_ES_ES' | 'LANGUAGE_FR_FR' | 'LANGUAGE_PT_BR' | 'LANGUAGE_NL_NL' — - LANGUAGE_UNSPECIFIED: Language unspecified - LANGUAGE_EN_US: Language en-US - LANGUAGE_EN_GB: Language en-GB - LANGUAGE_DE_DE: Language de-DE - LANGUAGE_ES_ES: Language es-ES - LANGUAGE_FR_FR: Language fr-FR - LANGUAGE_PT_BR: Language pt-BR - LANGUAGE_NL_NL: Language nl-NL - `phone_number` string — Phone number of the user - `notes_updated_by` string — The user ID of the last person who edited the internal notes. - `notes_updated_at` string, date-time — The timestamp of when the internal notes were last updated. - `company_type` S12TypefieldV1Type — Describes the values of a type. - `id` string — A global unique identifier for a type. - `name` string — Name of the type. - `description` string — Description of the type. - `type_category` 'TYPE_CATEGORY_UNSPECIFIED' | 'TYPE_CATEGORY_SYSTEM' | 'TYPE_CATEGORY_CUSTOM' — - TYPE_CATEGORY_UNSPECIFIED: Type Unspecified. - TYPE_CATEGORY_SYSTEM: Type pre-defined. - TYPE_CATEGORY_CUSTOM: Type custom. - `domain` 'DOMAIN_UNSPECIFIED' | 'DOMAIN_GLOBAL' | 'DOMAIN_ASSETS' | 'DOMAIN_CONTRACTORS' | 'DOMAIN_LICENSES_AND_CREDENTIALS' | 'DOMAIN_TASKS' | 'DOMAIN_USERS' | 'DOMAIN_INVESTIGATIONS' | 'DOMAIN_STRUCTURES' | 'DOMAIN_INTEGRATIONS_HRIS_STAGING' — The domain is used to specify which domain the data is coming from. This allows the shared generic type field service to keep track of which domain owns the data, and enforce any domain-specific access control rules. - DOMAIN_UNSPECIFIED: Domain Unspecified. - DOMAIN_GLOBAL: Owned and managed by system can be used by multiple domains - DOMAIN_ASSETS: Owned and created from Assets domain - DOMAIN_CONTRACTORS: Owned and created from Contractor Management domain - DOMAIN_LICENSES_AND_CREDENTIALS: Owned and created from the Licenses and Credentials domain - DOMAIN_TASKS: Owned and created from the Tasks domain - DOMAIN_USERS: Owned and created from the Users domain - DOMAIN_INVESTIGATIONS: Owned and created from the Investigations domain - DOMAIN_STRUCTURES: Owned and created from the Organisational Structures domain - DOMAIN_INTEGRATIONS_HRIS_STAGING: Owned and created from the Integrations domain - `stats` S12TypefieldV1TypeStats — Stats associated with a type. - `mapping_count` integer — The total number of mappings associated with a type. ## Other responses - `default` — An unexpected error response. --- [API](https://skmtc.net/safetyculture/apis/safetyculture-api.md) · [All operations](https://skmtc.net/safetyculture/apis/safetyculture-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/safetyculture/safetyculture-api/revisions/5be91df61ded/schema)