Accounts

List accounts

Returns a paginated list of accounts (companies) in the workspace. Supports filtering by indexed account columns.

Results are restricted to accounts sourced from a customer CRM (salesforce, hubspot).

get/accounts

Request

  • Base URL: https://partner-api.nooks.in/v1
  • URL: https://partner-api.nooks.in/v1/accounts
  • 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)

Query parameters

page[size]integer

Number of items per page (max 100)

page[after]string

Cursor for fetching the next page. Opaque token returned by the API in links.next; callers should treat it as opaque and only pass values they received from a previous response. Malformed cursors return 400 Bad Request.

page[before]string

Cursor for fetching the previous page. Opaque token returned by the API in links.prev; callers should treat it as opaque and only pass values they received from a previous response. Malformed cursors return 400 Bad Request.

filter[id]string

Comma-separated list of account UUIDs to fetch

filter[name]string

Filter accounts by exact name match

filter[domain]string

Filter accounts by exact domain match

filter[crmId]string

Filter accounts by CRM external ID

filter[updatedAt][gte]string date-time

Filter by minimum updatedAt (ISO 8601 datetime)

filter[updatedAt][lt]string date-time

Filter by updatedAt before this timestamp, exclusive (ISO 8601 datetime)

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

Example response

{
  "data": [
    {
      "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"
    }
  ],
  "links": {
    "first": "/v1/sequences?page[size]=50",
    "next": "/v1/sequences?page[size]=50&page[after]=eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCIsInYiOjF9"
  }
}

Changes

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