Objects

List companies

List companies with cursor pagination and optional properties, associations, and search filters.

Overview

Use this endpoint to read companies in pages. If properties is omitted, the default response includes name, domain, website, and lifecyclestage. Associations are returned only when you request them. It requires public api oauth access token authentication and the crm.companies.read scope.

GET/api/crm/objects/companies

cURL

GET

bash

curl --request GET \  --url 'https://crm.notifyy.io/api/crm/objects/companies?properties=name%2Cdomain&associations=contact&search=notifyy&limit=25' \  --header 'Authorization: Bearer nfy_public_api_access_token'

Authorization

Public API OAuth access token

crm.companies.read

Sample Request Body

This endpoint does not require a request body.

Sample Response

json

{  "success": true,  "message": "Companies retrieved successfully",  "data": {    "companies": [      {        "id": 55,        "properties": {          "name": "Notifyy",          "domain": "notifyy.io"        },        "associations": {          "contact": [            {              "id": "456",              "type": "company_to_contact"            }          ]        }      }    ],    "pagination": {      "nextCursor": "opaque-cursor",      "hasMore": true    }  }}

Status Codes

Code	Description
200	Companies were returned.

Headers

AuthorizationstringRequired

Public API OAuth bearer token.

Example: Bearer nfy_public_api_access_token

Object	Description
Authorization string	RequiredPublic API OAuth bearer token. Example: Bearer nfy_public_api_access_token

Query parameters

propertiesstringOptional

Comma-separated property internal names to return. Duplicate values are deduplicated.

Example: name,domain

associationsstringOptional

Comma-separated associated object types to include.

Example: contact

searchstringOptional

Search string forwarded to the CRM company query service.

Example: notifyy

cursorstringOptional

Opaque cursor returned by a previous list response.

limitintegerOptional

Page size. Defaults to 50 and the maximum is 100.

Example: 25

Object	Description
properties string	OptionalComma-separated property internal names to return. Duplicate values are deduplicated. Example: name,domain
associations string	OptionalComma-separated associated object types to include. Example: contact
search string	OptionalSearch string forwarded to the CRM company query service. Example: notifyy
cursor string	OptionalOpaque cursor returned by a previous list response.
limit integer	OptionalPage size. Defaults to 50 and the maximum is 100. Example: 25

Response fields

successboolean

Whether the request succeeded.

Example: true

messagestring

Human-readable result message.

Example: Companies retrieved successfully

data.companiesobject[]

List of matching companies.

data.companies[].idinteger

Company record ID.

Example: 55

data.companies[].propertiesobject

Requested company properties keyed by internal name.

data.companies[].associationsobject | null

Associated records grouped by object type when requested.

data.pagination.nextCursorstring | null

Cursor for the next page. Pass it back exactly as received.

data.pagination.hasMoreboolean

Whether another page is available.

Example: true

Object	Description
success boolean	Whether the request succeeded. Example: true
message string	Human-readable result message. Example: Companies retrieved successfully
data.companies object[]	List of matching companies.
data.companies[].id integer	Company record ID. Example: 55
data.companies[].properties object	Requested company properties keyed by internal name.
data.companies[].associations object \| null	Associated records grouped by object type when requested.
data.pagination.nextCursor string \| null	Cursor for the next page. Pass it back exactly as received.
data.pagination.hasMore boolean	Whether another page is available. Example: true