Authentication

Secure your API requests using standardized API Keys. PerCRM ensures all data is encrypted in transit and at rest.

info

PerCRM uses HTTP Basic Auth. Provide your API key as the username. You do not need to provide a password.

Your API Keys

You can manage your API keys in the Dashboard Settings. Keep your keys secret!

BASH

curl https://api.percrm.com/v1/leads \
  -u sk_live_8F...q1:

Example of an authenticated request

GET

List all calls

https://api.percrm.com/v1/calls

Returns a list of calls stored in your CRM account. The calls are returned in sorted order, with the most recent calls appearing first.

Query Parameters

Property Type Description

Property	Type	Description
limit	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100. Default: 10
agent_id	string	Only return calls handled by the specific agent.
status	string	Filter calls by status. Values: `missed`, `completed`, `busy`.

limit

integer

A limit on the number of objects to be returned. Limit can range between 1 and 100.

Default: 10

agent_id

string

Only return calls handled by the specific agent.

status

string

Filter calls by status. Values: missed, completed, busy.

curl -G https://api.percrm.com/v1/calls \
  -d limit=25 \
  -d status=completed \
  -u sk_live_8F...q1:

Response 200 OK

{
  "object": "list",
  "url": "/v1/calls",
  "has_more": true,
  "data": [
    {
      "id": "call_129312",
      "object": "call",
      "agent_id": "agt_8821",
      "duration": 342,
      "status": "completed",
      "customer": {
        "id": "cus_9921",
        "phone": "+15550123456"
      },
      "created_at": 1678892112
    },
    {
      "id": "call_129313",
      "object": "call",
      "agent_id": "agt_8821",
      "duration": 0,
      "status": "missed",
      "created_at": 1678891005
    }
  ]
}