Skip to content

Grinfi.io API (2.0.0)

Complete API reference for Grinfi.io — the all-in-one LinkedIn & email outreach platform. Use this API to manage your CRM contacts, run outreach automations, send messages, and integrate Grinfi with your own tools.

Authentication

All requests require a Bearer token in the Authorization header.

  1. Log in at leadgen.grinfi.io
  2. Go to Settings → API Keys
  3. Copy your key and pass it as:
    Authorization: Bearer YOUR_API_KEY

Pagination

List endpoints support limit (default 20) and offset (default 0) query parameters. Responses include total count and has_more boolean.

Filtering

Most list endpoints accept a filter object. Supported value types: | Type | Example | SQL equivalent | |------|---------|----------------| | Scalar | "status": "ok" | = 'ok' | | Array | "status": ["ok", "pending"] | IN ('ok', 'pending') | | Object | "created_at": {">=": "2024-01-01"} | >= '2024-01-01' | | "is_null" | "email": "is_null" | IS NULL | | "is_not_null" | "email": "is_not_null" | IS NOT NULL | Supported operators: =, !=, <, <=, >, >=, <>

Rate Limits

API requests are rate-limited per account. If you exceed the limit, you'll receive a 429 response. Use exponential backoff when retrying.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL
https://grinfi.io
Grinfi.io Support
support@grinfi.io
License
Copyright
Languages
Servers
Production
https://leadgen.grinfi.io

Contacts

Manage your CRM contacts (leads). Search, create, update, and organize contacts across lists and pipeline stages.

Operations

Companies

Manage company records in your CRM. Companies can be linked to contacts and enriched with additional data from LinkedIn.

Operations

Lists

Organize contacts into lists. Every contact must belong to a list. Use lists to segment your audience for outreach campaigns.

Operations

Tags

Label contacts and companies with custom tags for easy filtering and segmentation.

Operations

Pipeline

Define and manage pipeline stages to track where each contact stands in your sales or outreach process.

Operations

Custom Fields

Extend contact and company records with custom data fields. Store any additional information relevant to your workflow.

Operations

Notes

Add internal notes to contacts or companies for your team's reference.

Operations

Automations

Manage outreach automation sequences. Automations define multi-step workflows that send LinkedIn messages, emails, and perform other actions on a schedule.

Operations

Tasks

Create and manage outreach tasks such as sending LinkedIn messages or emails. Tasks can be created manually or generated by automations.

Operations

Sender Profiles

Sender profiles represent the LinkedIn and email accounts used to send outreach messages. Each profile links a LinkedIn browser and/or email mailbox.

Operations

LinkedIn Messages

Send and retrieve LinkedIn messages through your connected sender profiles.

Operations

Emails

Send and retrieve emails through your connected mailboxes.

Operations

Mailboxes

Manage email mailboxes (SMTP/IMAP, Gmail, Outlook) used for sending and receiving emails in outreach campaigns.

Operations

List mailboxes

Request

Retrieve all email mailboxes (SMTP/IMAP, Gmail, Outlook) configured in your account.

Security
bearerAuth
Query
limitinteger(int32)

Items per page (default 20).

Default 20
Example: limit=20
offsetinteger(int32)

Items to skip (default 0).

Default 0
Example: offset=0
order_fieldstring

Sort field (default created_at).

Default "created_at"
Example: order_field=created_at
order_typestring

Sort direction.

Default "asc"
Enum"asc""desc"
Example: order_type=asc
filterobject
curl -i -X GET \
  'https://leadgen.grinfi.io/emails/api/mailboxes?limit=20&offset=0&order_field=created_at&order_type=asc&q=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of mailboxes.

Bodyapplication/json
dataArray of objects(mailbox)
limitinteger
offsetinteger
totalinteger
Response
application/json
{
  "data": [
    { … }
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}

Create a mailbox

Request

Add a new SMTP/IMAP mailbox with connection settings.

Security
bearerAuth
Bodyapplication/jsonrequired
emailstringrequired
Example: "outreach@company.com"
sender_namestringrequired
Example: "John from Company"
sender_profile_uuidstringrequired
providerstring
connection_settingsobject
automation_daily_limitinteger
Example: 50
automation_task_intervalinteger
Example: 120
curl -i -X POST \
  https://leadgen.grinfi.io/emails/api/mailboxes \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "outreach@company.com",
    "sender_name": "John from Company",
    "sender_profile_uuid": "string",
    "provider": "string",
    "connection_settings": {
      "smtp_host": "string",
      "smtp_port": 0,
      "smtp_username": "string",
      "smtp_password": "string",
      "imap_host": "string",
      "imap_port": 0,
      "imap_username": "string",
      "imap_password": "string"
    },
    "automation_daily_limit": 50,
    "automation_task_interval": 120
  }'

Responses

Mailbox created.

Bodyapplication/json
uuidstring
team_idinteger
user_idinteger
sender_profile_uuidstring
emailstring
Example: "outreach@company.com"
sender_namestring
Example: "John from Company"
providerstring
statusstring
automation_daily_limitinteger
Example: 50
automation_task_intervalinteger
Example: 120
custom_tracking_domain_uuidstring or null
connection_settingsobject
created_atstring(date-time)
updated_atstring(date-time)
Response
application/json
{
  "uuid": "string",
  "team_id": 0,
  "user_id": 0,
  "sender_profile_uuid": "string",
  "email": "outreach@company.com",
  "sender_name": "John from Company",
  "provider": "string",
  "status": "string",
  "automation_daily_limit": 50,
  "automation_task_interval": 120,
  "custom_tracking_domain_uuid": "string",
  "connection_settings": {},
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Get a mailbox

Request

Retrieve details of a specific mailbox.

Security
bearerAuth
Path
uuidstringrequired

Resource UUID.

curl -i -X GET \
  'https://leadgen.grinfi.io/emails/api/mailboxes/{uuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Mailbox details.

Bodyapplication/json
uuidstring
team_idinteger
user_idinteger
sender_profile_uuidstring
emailstring
Example: "outreach@company.com"
sender_namestring
Example: "John from Company"
providerstring
statusstring
automation_daily_limitinteger
Example: 50
automation_task_intervalinteger
Example: 120
custom_tracking_domain_uuidstring or null
connection_settingsobject
created_atstring(date-time)
updated_atstring(date-time)
Response
application/json
{
  "uuid": "string",
  "team_id": 0,
  "user_id": 0,
  "sender_profile_uuid": "string",
  "email": "outreach@company.com",
  "sender_name": "John from Company",
  "provider": "string",
  "status": "string",
  "automation_daily_limit": 50,
  "automation_task_interval": 120,
  "custom_tracking_domain_uuid": "string",
  "connection_settings": {},
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

AI Templates

Manage AI message templates for generating personalized outreach messages at scale.

Operations