Identity API
Interfaces to manage LinkedIn and Twitter identities
An Identity represents a connected LinkedIn or Twitter account. Identities are created automatically through the SuperSend Chrome extension when you connect your social accounts.
V2 API Available
Response Format
V2 endpoints and app-compat V1 endpoints return a standardized response with success, data (or message), and request_id. Legacy V1 endpoints may return different shapes. Errors return:
{
"error": {
"type": "invalid_request_error",
"code": "missing_team_id",
"message": "TeamId is required",
"param": "TeamId",
"doc_url": "https://docs.supersend.io/docs/errors#missing_team_id"
},
"request_id": "req_a1b2c3d4e5f6789012345678"
}List Identities
Get all identities for your organization.
V2 API (Recommended)
curl -X GET 'https://api.supersend.io/v2/identities?team_id=xxx&type=linkedin&status=active&limit=20' \
-H "Authorization: Bearer YOUR_API_KEY"# Response (200 OK)
{
"success": true,
"data": [
{
"object": "identity",
"id": "identity-uuid",
"type": "linkedin",
"handle": "john-doe-12345",
"username": "John Doe",
"email": "john@example.com",
"first_name": "John",
"last_name": "Doe",
"photo": "https://media.licdn.com/...",
"status": "active",
"error": null,
"settings": {
"max_messages_per_day": 50,
"max_connection_requests_per_day": 20,
"max_profile_visits_per_day": 100,
"max_likes_per_day": 30,
"action_cooldown_seconds": 60,
"timezone": "America/New_York",
"days": [1, 2, 3, 4, 5],
"hours": [{"start": "09:00", "end": "17:00"}]
},
"sender_profile": {
"id": "profile-uuid",
"name": "Sales Profile"
},
"team_id": "team-uuid",
"org_id": "org-uuid",
"created_at": "2025-01-01T00:00:00Z",
"updated_at": "2025-01-15T00:00:00Z"
}
],
"pagination": {
"total": 2,
"limit": 20,
"offset": 0,
"hasMore": false
},
"request_id": "req_a1b2c3d4e5f6789012345678"
}
V2 Query Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
team_id | string | No | Filter by team ID |
type | string | No | Filter by type: linkedin or twitter |
status | string | No | Filter by status: active or inactive |
limit | number | No | Results per page (default: 50, max: 100) |
offset | number | No | Pagination offset (default: 0) |
V1 API
curl -X GET 'https://api.supersend.io/v1/identities' \
-H "Authorization: Bearer YOUR_API_KEY"Get Identity
Get a specific identity by ID.
V2 API (Recommended)
curl -X GET 'https://api.supersend.io/v2/identities/identity-uuid' \
-H "Authorization: Bearer YOUR_API_KEY"# Response (200 OK)
{
"success": true,
"data": {
"object": "identity",
"id": "identity-uuid",
"type": "linkedin",
"handle": "john-doe-12345",
"username": "John Doe",
"email": "john@example.com",
"first_name": "John",
"last_name": "Doe",
"photo": "https://media.licdn.com/...",
"bio": "Sales professional...",
"status": "active",
"error": null,
"failures": 0,
"settings": {
"max_messages_per_day": 50,
"max_connection_requests_per_day": 20,
"max_profile_visits_per_day": 100,
"max_likes_per_day": 30,
"action_cooldown_seconds": 60,
"timezone": "America/New_York",
"days": [1, 2, 3, 4, 5],
"hours": [{"start": "09:00", "end": "17:00"}],
"inbox_privacy_setting": 1
},
"sender_profile": {
"id": "profile-uuid",
"name": "Sales Profile"
},
"team_id": "team-uuid",
"org_id": "org-uuid",
"created_at": "2025-01-01T00:00:00Z",
"updated_at": "2025-01-15T00:00:00Z"
},
"request_id": "req_a1b2c3d4e5f6789012345678"
}
inbox_privacy_setting values:
1 - Team (team members can see inbox)2 - Private (only identity owner can see inbox)3 - Organization (all org members can see inbox)Update Identity
Update identity settings.
V2 API (Recommended)
curl -X PATCH 'https://api.supersend.io/v2/identities/identity-uuid' \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"max_messages_per_day": 75,
"max_connection_requests_per_day": 30,
"max_profile_visits_per_day": 150,
"max_likes_per_day": 50,
"action_cooldown_seconds": 90,
"timezone": "America/Los_Angeles",
"days": {
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": false,
"sunday": false
},
"hours": [
{"start": "08:00", "end": "18:00"}
],
"inbox_privacy_setting": 2,
"status": "active"
}'# Response (200 OK)
{
"success": true,
"data": {
"object": "identity",
"id": "identity-uuid",
"type": "linkedin",
"handle": "john-doe-12345",
"username": "John Doe",
"email": "john@example.com",
"first_name": "John",
"last_name": "Doe",
"photo": "https://media.licdn.com/...",
"bio": "Sales professional...",
"status": "active",
"error": null,
"settings": {
"max_messages_per_day": 75,
"max_connection_requests_per_day": 30,
"max_profile_visits_per_day": 150,
"max_likes_per_day": 50,
"action_cooldown_seconds": 90,
"timezone": "America/Los_Angeles",
"days": [1, 2, 3, 4, 5],
"hours": [{"start": "08:00", "end": "18:00"}],
"inbox_privacy_setting": 2
},
"sender_profile": {...},
"team_id": "team-uuid",
"org_id": "org-uuid",
"created_at": "2025-01-01T00:00:00Z",
"updated_at": "2025-01-15T00:00:00Z"
},
"request_id": "req_a1b2c3d4e5f6789012345678"
}
V2 Update Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
max_messages_per_day | number | No | Max messages per day (0-200) |
max_connection_requests_per_day | number | No | Max connection requests per day (0-100) |
max_profile_visits_per_day | number | No | Max profile visits per day (0-200) |
max_likes_per_day | number | No | Max likes per day (0-100) |
action_cooldown_seconds | number | No | Cooldown between actions in seconds (30-600) |
timezone | string | No | Timezone (e.g., "America/New_York") |
days | object | No | Days of week object with boolean values (monday-sunday) |
hours | array | No | Array of time ranges: [{"start": "09:00", "end": "17:00"}] |
inbox_privacy_setting | number | No | Privacy setting: 1=team, 2=private, 3=organization |
status | string | No | Status: active or inactive |
Note: At least one parameter is required.
Delete Identity
Remove an identity from your account.
V2 API (Recommended)
curl -X DELETE 'https://api.supersend.io/v2/identities/identity-uuid' \
-H "Authorization: Bearer YOUR_API_KEY"# Response (200 OK)
{
"success": true,
"message": "Identity disconnected successfully",
"request_id": "req_a1b2c3d4e5f6789012345678"
}
V1 API
curl -X DELETE 'https://api.supersend.io/v1/identity/identity-uuid' \
-H "Authorization: Bearer YOUR_API_KEY"Identity Types
| Type | Value | Description |
|---|---|---|
linkedin (V2) / 1 (V1) | LinkedIn account | |
twitter (V2) / 2 (V1) | Twitter/X account |
Privacy Settings
| Setting | Description |
|---|---|
team | Inbox visible to all team members |
private | Inbox only visible to owner |
hidden | Inbox completely hidden |
V1 vs V2 Endpoint Mapping
| Action | V1 Endpoint | V2 Endpoint |
|---|---|---|
| List | GET /v1/identities | GET /v2/identities |
| Get | Not available | GET /v2/identities/:id |
| Update | Not available | PATCH /v2/identities/:id |
| Delete | DELETE /v1/identity/:id | DELETE /v2/identities/:id |