Companies

Get a company

Fetch a company profile and high-level account health metrics.

Overview

Use this API to fetch a company profile and high-level account health metrics. It requires bearer api key authentication and the companies:read scope.

GET/companies/{companyId}

cURL

GET

bash

curl --request GET \  --url 'https://api.atlascrm.dev/v1/companies/cmp_123' \  --header 'Authorization: Bearer crm_live_xxx'

Authorization

Bearer API key

companies:read

Sample Request Body

This endpoint does not require a request body.

Sample Response

json

{  "status": "success",  "data": {    "id": "cmp_123",    "name": "Northstar Labs",    "domain": "northstar.example",    "healthScore": 86  }}

Status Codes

Code	Description
200	Company was returned.

Headers

AuthorizationstringRequired

Bearer token for your workspace.

Example: Bearer crm_live_xxx

Object	Description
Authorization string	RequiredBearer token for your workspace. Example: Bearer crm_live_xxx

Path parameters

companyIdstringRequired

Company identifier.

Example: cmp_123

Object	Description
companyId string	RequiredCompany identifier. Example: cmp_123

Response fields

data.idstring

Company identifier.

data.namestring

Company display name.

data.healthScorenumber

Account health score from 0 to 100.

Object	Description
data.id string	Company identifier.
data.name string	Company display name.
data.healthScore number	Account health score from 0 to 100.