Calls

Get call by ID

Returns a single call made on the Nooks SEP by its unique identifier.

get/calls/{id}

Request

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

Path parameters

idstring uuid required

Unique identifier for the call

Query parameters

includestring[]

Comma-separated relations to expand inline. Valid values: prospect, sequence, sequenceStep, callDisposition, owner. Max 3.

Response

Successful response

idstring uuid required

Unique identifier for the call

sourcestring required

Source/type of the call (e.g., nooks, outreach, salesforce)

durationnumber required

Duration of the call in seconds

fromstring nullable required

Phone number of the rep who made/received the call

tostring nullable required

Phone number of the prospect

directionstring nullable required

Direction of the call

recordingUrlstring nullable required

URL to the call recording

timestring date-time required

Wall-clock time the call actually happened. Distinct from createdAt (ingestion time). time is what the dialer or telephony layer recorded. Use this for call-time-based queries and filtering.

createdAtstring date-time required

When the call was created

updatedAtstring date-time required

When the call was last updated

Example response

{
  "id": "ff0e8400-e29b-41d4-a716-446655440060",
  "source": "nooks",
  "duration": 120.5,
  "from": "+14155551234",
  "to": "+14155555678",
  "direction": "outgoing",
  "recordingUrl": "https://example.com/recordings/abc123",
  "time": "2025-11-01T09:57:12.000Z",
  "prospect": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
  },
  "sequence": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
  },
  "sequenceStep": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
  },
  "callDisposition": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
  },
  "owner": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
  },
  "createdAt": "2025-11-01T10:00:00.000Z",
  "updatedAt": "2025-11-05T14:30:00.000Z"
}

Changes

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