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

List automations

Request

Retrieve all outreach automations in your account. Automations are multi-step sequences that send LinkedIn messages, emails, and other actions on a schedule.

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

Filters.

curl -i -X GET \
  'https://leadgen.grinfi.io/flows/api/flows?limit=20&offset=0&order_field=created_at&order_type=asc&q=string&status=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of automations.

Bodyapplication/json
dataArray of objects(flow)
limitinteger
Example: 20
offsetinteger
Example: 0
totalinteger
Example: 15
has_moreboolean
Response
application/json
{
  "data": [
    { … }
  ],
  "limit": 20,
  "offset": 0,
  "total": 15,
  "has_more": true
}

Get an automation

Request

Retrieve full details of an automation by UUID.

Security
bearerAuth
Path
flowUuidstringrequired

Automation UUID.

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

Responses

Automation details.

Bodyapplication/json
uuidstring
Example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
public_uuidstring or null
team_idinteger
namestring
Example: "DACH CTO Outreach"
flow_workspace_uuidstring or null
flow_version_uuidstring
scheduleobject(schedule)

Working hours schedule.

descriptionstring or null
priorityinteger
statusstring

on, off, or archived.

Example: "on"
is_publicboolean
user_idinteger
created_atstring(date-time)
updated_atstring(date-time)
Response
application/json
{
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "public_uuid": "string",
  "team_id": 0,
  "name": "DACH CTO Outreach",
  "flow_workspace_uuid": "string",
  "flow_version_uuid": "string",
  "schedule": {
    "timezone": "Europe/Berlin",
    "use_lead_timezone": false,
    "timeblocks": [ … ]
  },
  "description": "string",
  "priority": 0,
  "status": "on",
  "is_public": true,
  "user_id": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Update an automation

Request

Update an automation's name, description, or schedule.

Security
bearerAuth
Path
flowUuidstringrequired

Automation UUID.

Bodyapplication/jsonrequired
namestring
Example: "Updated Campaign Name"
descriptionstring
scheduleobject(schedule)

Working hours schedule.

curl -i -X PUT \
  'https://leadgen.grinfi.io/flows/api/flows/{flowUuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Updated Campaign Name",
    "description": "string",
    "schedule": {
      "timezone": "Europe/Berlin",
      "use_lead_timezone": false,
      "timeblocks": [
        {
          "dow": 0,
          "from": 540,
          "to": 1080
        }
      ]
    }
  }'

Responses

Updated automation.

Bodyapplication/json
uuidstring
Example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
public_uuidstring or null
team_idinteger
namestring
Example: "DACH CTO Outreach"
flow_workspace_uuidstring or null
flow_version_uuidstring
scheduleobject(schedule)

Working hours schedule.

descriptionstring or null
priorityinteger
statusstring

on, off, or archived.

Example: "on"
is_publicboolean
user_idinteger
created_atstring(date-time)
updated_atstring(date-time)
Response
application/json
{
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "public_uuid": "string",
  "team_id": 0,
  "name": "DACH CTO Outreach",
  "flow_workspace_uuid": "string",
  "flow_version_uuid": "string",
  "schedule": {
    "timezone": "Europe/Berlin",
    "use_lead_timezone": false,
    "timeblocks": [ … ]
  },
  "description": "string",
  "priority": 0,
  "status": "on",
  "is_public": true,
  "user_id": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

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

AI Templates

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

Operations