Accounts

Get account by ID

Returns a single account by its unique identifier.

get/accounts/{id}

Request

  • Base URL: https://partner-api.nooks.in/v1
  • URL: https://partner-api.nooks.in/v1/accounts/{id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://oauth.nooks.in/oauth/authorize, token URL https://oauth.nooks.in/oauth/token, scopes: accounts:read)

Path parameters

idstring uuid required

Unique identifier for the account

Query parameters

includeCRMCustomFields'true' | 'false'

When true, each returned record's crmCustomFields carries the record's CRM custom fields as a single JSON object keyed by the CRM field id/key (e.g. {"hs_lead_status": "OPEN"}). Values are typed per the CRM field's data type (string, number, boolean, string array, or ISO-8601 date string, so a date field's value is not distinguishable from a string field's on the wire). A registered field with no stored value is null. Only fields with a currently-registered CRM attribute definition in the workspace are returned. The field itself is always present in responses; without this opt-in (the default) it is an empty object {} and no custom-field data is fetched.

Response

Successful response

idstring uuid required

Unique identifier for the account

namestring nullable required

Name of the account (company)

domainstring nullable required

Primary domain associated with the account

numEmployeesinteger nullable required

Number of employees at the account

linkedInUrlstring uri nullable required

LinkedIn company page URL

descriptionstring nullable required

Free-form description of the account

crmCustomFieldsobject required

CRM custom fields as a JSON object keyed by the CRM field id/key. Always present; populated only when the request passed includeCRMCustomFields=true, otherwise an empty object {}.

createdAtstring date-time required

When the account was created

updatedAtstring date-time required

When the account was last updated

Example response

{
  "id": "aa0e8400-e29b-41d4-a716-446655440030",
  "name": "Acme Corp",
  "domain": "acme.com",
  "numEmployees": 500,
  "linkedInUrl": "https://linkedin.com/company/acme",
  "description": "B2B SaaS for the manufacturing sector.",
  "crmCustomFields": {
    "Industry": "SaaS",
    "Employee_Count__c": 250,
    "Is_Strategic__c": true
  },
  "createdAt": "2025-09-01T10:00:00.000Z",
  "updatedAt": "2025-11-15T14:30:00.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.