Objects

Get a company

Retrieve a single company by company ID.

Overview

Use this endpoint to read one company record. You can limit the returned property set with the properties query parameter and include associations when needed. It requires public api oauth access token authentication and the crm.companies.read scope.

GET/api/crm/objects/companies/{companyId}

cURL

GET

bash

curl --request GET \  --url 'https://crm.notifyy.io/api/crm/objects/companies/55?properties=name%2Cwebsite&associations=contact%2Cdeal' \  --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": "Company retrieved successfully",  "data": {    "id": 55,    "properties": {      "name": "Notifyy",      "website": "https://notifyy.io"    },    "associations": {      "contact": [        {          "id": "456",          "type": "company_to_contact"        }      ],      "deal": [        {          "id": "789",          "type": "deal_to_company"        }      ]    }  }}

Status Codes

Code	Description
200	Company was returned.
404	Company not found in the token-bound tenant and project.

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

Path parameters

companyIdintegerRequired

Company ID.

Example: 55

Object	Description
companyId integer	RequiredCompany ID. Example: 55

Query parameters

propertiesstringOptional

Comma-separated property internal names to return.

Example: name,website

associationsstringOptional

Comma-separated associated object types to include.

Example: contact,deal

Object	Description
properties string	OptionalComma-separated property internal names to return. Example: name,website
associations string	OptionalComma-separated associated object types to include. Example: contact,deal

Response fields

successboolean

Whether the request succeeded.

Example: true

messagestring

Human-readable result message.

Example: Company retrieved successfully

data.idinteger

Company record ID.

Example: 55

data.propertiesobject

Requested company properties keyed by internal name.

data.associationsobject | null

Associated records grouped by object type when requested.

Object	Description
success boolean	Whether the request succeeded. Example: true
message string	Human-readable result message. Example: Company retrieved successfully
data.id integer	Company record ID. Example: 55
data.properties object	Requested company properties keyed by internal name.
data.associations object \| null	Associated records grouped by object type when requested.