Project Management and Keyword Tracking API Documentation (v1)

Bring our project management into your own platform. Manage your links and contacts for a domain, and organize your custom keyword groups.

Authentication

Basic Auth Token

Security scheme type:	HTTP
HTTP Authorization Scheme	basic

api_key

Secret Key Authentication

Security scheme type:	API Key
Query parameter name:	api_key

ProjectsApi

Read, create, update, and delete projects to manage outreach and keyword tracking.

Returns list of projects belonging to user

get /projects/list

https://www.spyfu.com:80/apis/my_spyfu_api/projects/list

query Parameters

userId required	string <uuid> User's ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/projects/list?userId=USER_GUID&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "id": "string",
- "projectName": "string",
- "dateCreated": "2025-06-14T19:54:00Z",
- "dateModified": "2025-06-14T19:54:00Z",
- "primaryDomainName": "string",
- "primaryDomainId": "string"
}

]

Create a new project

get /projects/create

https://www.spyfu.com:80/apis/my_spyfu_api/projects/create

query Parameters

userId required	string <uuid> User's ID
projectName required	string Name of project
primaryDomainName required	string Domain to track for all keyword metrics
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/projects/create?userId=USER_GUID&projectName=SpyFu&primaryDomainName=spyfu.com&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "id": "string",
- "projectName": "string",
- "dateCreated": "2025-06-14T19:54:00Z",
- "dateModified": "2025-06-14T19:54:00Z",
- "primaryDomainName": "string",
- "primaryDomainId": "string"
}

]

Deletes an existing project

get /projects/delete

https://www.spyfu.com:80/apis/my_spyfu_api/projects/delete

query Parameters

userId required	string <uuid> User's ID
projectId required	string <uuid> Project ID
api_key	string User's secret key

Responses

204

NoContent

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/projects/delete?userId=USER_GUID&projectId=PROJECT_GUID&api_key=SECRET_KEY"

Updates an existing project

get /projects/update

https://www.spyfu.com:80/apis/my_spyfu_api/projects/update

query Parameters

userId required	string <uuid> User's ID
projectId required	string <uuid> Project ID
projectName required	string Name of project
primaryDomainName required	string Domain to track for all keyword metrics
api_key	string User's secret key

Responses

204

NoContent

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/projects/update?userId=USER_GUID&projectId=PROJECT_GUID&projectName=SpyFu&domainId=spyfu.com&api_key=SECRET_KEY"

Move a domain and all linked data from one project to another

get /projects/migratedomain

https://www.spyfu.com:80/apis/my_spyfu_api/projects/migratedomain

query Parameters

userId required	string <uuid> User's ID
newProjectId required	string <uuid> Project ID to migrate to
oldProjectId required	string <uuid> Project ID to migrate from
domainId required	integer <int64> Domain ID
api_key	string User's secret key

Responses

204

NoContent

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/projects/migratedomain?userId=USER_GUID&newProjectId=PROJECT_GUID&oldProjectId=PROJECT_GUID&domainId=DOMAIN_GUID&api_key=SECRET_KEY"

Find projects that include these urls

post /projects/searchbyurls

https://www.spyfu.com:80/apis/my_spyfu_api/projects/searchbyurls

query Parameters

api_key

string

User's secret key

Request Body schema:
application/json

Search parameters

userId	string <uuid> User's ID
urlsCsv	string Comma-separated URLs to search
projectId	string <uuid> Project ID

Responses

200

500

InternalServerError

Request samples

Payload
cURL
JS
C#
PHP

Content type

Copy

Expand all Collapse all

{

"userId": "string",
"urlsCsv": "string",
"projectId": "string"

}

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "projectId": "string",
- "urlId": "string",
- "projectName": "string",
- "hasUrl": true
}

]

Find projects that include these terms

post /projects/searchbyterms

https://www.spyfu.com:80/apis/my_spyfu_api/projects/searchbyterms

query Parameters

api_key

string

User's secret key

Request Body schema:
application/json

Search parameters

userId	string <uuid> User's ID
termIdsCsv	string Comma-separated term IDs to search
projectId	string <uuid> Project ID
groupHash	integer <int64> Filter by group ID
labelHash	integer <int64> Filter by label ID

Responses

200

500

InternalServerError

Request samples

Payload
cURL
JS
C#
PHP

Content type

Copy

Expand all Collapse all

{

"userId": "string",
"termIdsCsv": "string",
"projectId": "string",
"groupHash": 0,
"labelHash": 0

}

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "projectId": "string",
- "projectName": "string",
- "hasKeyword": true,
- "termId": "string"
}

]

KeywordsApi

Read, create, update, and delete keywords for projects.

Get list of keywords for a project

get /keywords/list

https://www.spyfu.com:80/apis/my_spyfu_api/keywords/list

query Parameters

userId required	string <uuid> User's ID
projectId required	string <uuid> Project ID
projectDomain required	string
groupHash	integer <int64> Filter by group ID
labelHash	integer <int64> Filter by label ID
sortColumn	string Sort by column
sortOrder	string Sort ASC or DESC
filterTerm	string Filter by term
startRow	integer <int32> Starting row (defaults to 1st)
rowsToDisplay	integer <int32> Maximum number of rows
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/keywords/list?userId=USER_GUID&projectId=PROJECT_GUID&projectDomain=SpyFu&groupHash=1506559589241584998&labelHash=-4149933402935822247&sortColumn=term&sortOrder=DESC&filterTerm=keyword tool&startRow=1&rowsToDisplay=250&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"keywords":
[
- {
  - "term": "string",
  - "termId": "string",
  - "monthlySearches": "string",
  - "rankingDifficulty": "string",
  - "rankChange": "string",
  - "currentRank": 0,
  - "previousRank": 0,
  - "currentMonthlyPosition": 0,
  - "previousMonthlyPosition": 0,
  - "monthlyChange": 0,
  - "costPerClick": "string",
  - "wasPreviouslySearched": true,
  - "wasCurrentlySearched": true,
  - "wasCurrentMonthlySearched": true,
  - "needsLuceneData": true,
  - "clickChange": 0,
  - "clicks": 0,
  - "groupsCsv":
    [
    "string"
    ],
  - "labelsCsv":
    [
    "string"
    ]
  }
],
"totalRowCount": 0,
"details":
{
- "avgAdPosition": 0,
- "avgAdPositionChange": 0,
- "bothCount": 0,
- "estClickChange": 0,
- "estMonthlyClicks": 0,
- "groupHash": 0,
- "groupName": "string",
- "impressionShare": 0,
- "impressionShareChange": 0,
- "improvedRanks": 0,
- "lostRanks": 0,
- "newlyRankedKeywords": 0,
- "numberOfKeywords": 0,
- "organicCount": 0,
- "paidCount": 0,
- "potentialClicks": 0,
- "rankChange": 0,
- "topOfPagePct": 0,
- "topOfPagePctChange": 0,
- "groupHistory":
  [
  - {
    "avgAdPosition": 0,
    "estMonthlyClicks": 0,
    "impressionShare": 0,
    "searchDateId": 0,
    "sumOfRanks": 0,
    "topOfPagePercentage": 0
    }
  ]
}

}

Add new keywords to a project

post /keywords/create

https://www.spyfu.com:80/apis/my_spyfu_api/keywords/create

query Parameters

api_key

string

User's secret key

Request Body schema:
application/json

List of keywords to add

userId	string <uuid> User's ID
projectId	string <uuid> Project ID
termCsv	string Comma-separated terms

Responses

200

500

InternalServerError

Request samples

Payload
cURL
JS
C#
PHP

Content type

Copy

Expand all Collapse all

{

"userId": "string",
"projectId": "string",
"termCsv": "string"

}

Response samples

Content type

Copy

Expand all Collapse all

{

"insertedCount": 0

}

Remove keywords from a project

post /keywords/delete

https://www.spyfu.com:80/apis/my_spyfu_api/keywords/delete

query Parameters

api_key

string

User's secret key

Request Body schema:
application/json

List of keyword IDs to remove

userId	string <uuid> User's ID
projectId	string <uuid> Project ID
termIdsCsv	string Comma-separated term IDs

Responses

200

500

InternalServerError

Request samples

Payload
cURL
JS
C#
PHP

Content type

Copy

Expand all Collapse all

{

"userId": "string",
"projectId": "string",
"termIdsCsv": "string"

}

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "deletedTermId": 0,
- "groupHashCsv": "string",
- "labelNamesCsv": "string"
}

]

Undo a recent keyword deletion

post /keywords/undo_delete

https://www.spyfu.com:80/apis/my_spyfu_api/keywords/undo_delete

query Parameters

api_key

string

User's secret key

Request Body schema:
application/json

userId	string <uuid> User's ID
projectId	string <uuid> Project ID
termIdsCsv	string Comma-separated term IDs

Responses

204

NoContent

500

InternalServerError

Request samples

Payload
cURL
JS
C#
PHP

Content type

Copy

Expand all Collapse all

{

"userId": "string",
"projectId": "string",
"termIdsCsv": "string"

}

Move keywords from one project to another

post /keywords/migrate_to_project

https://www.spyfu.com:80/apis/my_spyfu_api/keywords/migrate_to_project

query Parameters

api_key

string

User's secret key

Request Body schema:
application/json

userId	string <uuid> User's ID
oldProjectId	string <uuid> Project ID to migrate from
newProjectId	string <uuid> Project ID to migrate to
termIdsCsv	string Comma-separated term IDs

Responses

204

NoContent

500

InternalServerError

Request samples

Payload
cURL
JS
C#
PHP

Content type

Copy

Expand all Collapse all

{

"userId": "string",
"oldProjectId": "string",
"newProjectId": "string",
"termIdsCsv": "string"

}

Export project keywords as a CSV

get /keywords/export

https://www.spyfu.com:80/apis/my_spyfu_api/keywords/export

query Parameters

userId required	string <uuid> User's ID
projectId required	string <uuid> Project ID
projectDomain required	string Project's primary domain
groupHash required	integer <int64> Filter by group ID
labelHash required	integer <int64> Filter by label ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/keywords/export?userId=USER_GUID&projectId=PROJECT_GUID&projectDomain=SpyFu&groupHash=1506559589241584998&labelHash=-4149933402935822247&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

"string"

Bulk import keywords with associated groups and/or labels

post /keywords/import

https://www.spyfu.com:80/apis/my_spyfu_api/keywords/import

query Parameters

api_key

string

User's secret key

Request Body schema:
application/json

userId	string <uuid> User's ID
projectId	string <uuid> Project ID
termCsv	string Comma-separated terms
groupNameCsv	string Comma-separated groups
labelNameCsv	string Comma-separated labels

Responses

200

500

InternalServerError

Request samples

Payload
cURL
JS
C#
PHP

Content type

Copy

Expand all Collapse all

{

"userId": "string",
"projectId": "string",
"termCsv": "string",
"groupNameCsv": "string",
"labelNameCsv": "string"

}

Response samples

Content type

Copy

Expand all Collapse all

{

"termCount": 0,
"hasReachedLimit": true,
"termIdsCsv": "string",
"groupCount": 0,
"labelCount": 0,
"labelHashCsv": "string",
"groupHashCsv": "string",
"rejectedTerms":
[
- "string"
],
"alreadyActiveTerms":
[
- "string"
]

}

Bulk import keywords with associated groups and/or labels

post /keywords/import_with_ids

https://www.spyfu.com:80/apis/my_spyfu_api/keywords/import_with_ids

query Parameters

api_key

string

User's secret key

Request Body schema:
application/json

userId	string <uuid> User's ID
projectId	string <uuid> Project ID
termCsv	string Comma-separated terms
groupHashCsv	string Comma-separated group hashes
labelHashCsv	string Comma-separated label hashes

Responses

200

500

InternalServerError

Request samples

Payload
cURL
JS
C#
PHP

Content type

Copy

Expand all Collapse all

{

"userId": "string",
"projectId": "string",
"termCsv": "string",
"groupHashCsv": "string",
"labelHashCsv": "string"

}

Response samples

Content type

Copy

Expand all Collapse all

{

"termCount": 0,
"hasReachedLimit": true,
"termIdsCsv": "string",
"groupCount": 0,
"labelCount": 0,
"labelHashCsv": "string",
"groupHashCsv": "string",
"rejectedTerms":
[
- "string"
],
"alreadyActiveTerms":
[
- "string"
]

}

Create a new project with pre-populated keywords

post /keywords/new_project_import

https://www.spyfu.com:80/apis/my_spyfu_api/keywords/new_project_import

query Parameters

api_key

string

User's secret key

Request Body schema:
application/json

userId	string <uuid> User's ID
projectId	string <uuid> Project ID
domain	string Project's primary domain
mostSearched	boolean Include most searched keyword group
opportunities	boolean Include biggest opportunites keyword group
easyWins	boolean Include easy wins keyword group
topRecommendations	boolean Include top recommendations keyword group
customGroups	string JSON stringified object of custom groups

Responses

200

500

InternalServerError

Request samples

Payload
cURL
JS
C#
PHP

Content type

Copy

Expand all Collapse all

{

"userId": "string",
"projectId": "string",
"domain": "string",
"mostSearched": true,
"opportunities": true,
"easyWins": true,
"topRecommendations": true,
"customGroups": "string"

}

Response samples

Content type

Copy

Expand all Collapse all

{

"createdTerms": "string",
"createdGroups": "string"

}

Get list of keyword rank tracking data for a project

get /keywords/tracking

https://www.spyfu.com:80/apis/my_spyfu_api/keywords/tracking

query Parameters

userId required	string <uuid> User's ID
projectId required	string <uuid> Project ID
termId required	integer <int64> Term ID
domainId required	integer <int64> Domain ID
domainName required	string Domain name
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/keywords/tracking?userId=USER_GUID&projectId=PROJECT_GUID&termId=29183997&domainId=DOMAIN_GUID&domainName=spyfu.com&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"organicRankingHistory":
[
- {
  - "date": 0,
  - "rank": 0
  }
],
"rankChange": 0,
"trackingSummary":
{
- "term": "string",
- "bingImpressionShare": 0,
- "bingAveragePosition": 0,
- "googleImpressionShare": 0,
- "googleAveragePosition": 0,
- "termClicks": 0,
- "termClicksChange": 0,
- "termSearchVolume": 0
},
"weeklyTracking":
[
- {
  - "date": 0,
  - "bingAdPosition": 0,
  - "bingOrganicPosition": 0,
  - "googleAdPosition": 0,
  - "googleOrganicPosition": 0,
  - "topGoogleAdRatio": 0,
  - "topBingAdRatio": 0,
  - "googleImpressionShare": 0,
  - "bingImpressionShare": 0,
  - "googleWasSearched": true,
  - "bingWasSearched": true,
  - "googleSerpUrl": "string"
  }
]

}

Get current keyword usage and maximum allowed per user

get /keywords/keywordcount

https://www.spyfu.com:80/apis/my_spyfu_api/keywords/keywordcount

query Parameters

userId required	string <uuid> User's ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/keywords/keywordcount?userId=USER_GUID&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"usedCount": 0,
"totalCount": 0,
"mySpyFuCount": 0,
"weeklyTrackingCount": 0,
"keywordRankingReportCount": 0

}

KeywordGroupsApi

Read, create, update, and delete keyword groups for projects.

Get list of groups for a project

get /groups/list

https://www.spyfu.com:80/apis/my_spyfu_api/groups/list

query Parameters

userId required	string <uuid> User's ID
projectId required	string <uuid> Project ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/groups/list?userId=USER_GUID&projectId=PROJECT_GUID&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "projectId": "string",
- "name": "string",
- "groupHash": "string",
- "numberOfKeywords": 0,
- "rankChange": 0,
- "shareChange": 0,
- "impressionShare": 0,
- "clickChange": 0
}

]

Add new keyword group to a project

get /groups/create

https://www.spyfu.com:80/apis/my_spyfu_api/groups/create

query Parameters

userId required	string <uuid> User's ID
projectId required	string <uuid> Project ID
name required	string Group name
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/groups/create?userId=USER_GUID&projectId=PROJECT_GUID&name=Hot Leads&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"groupHash": "string",
"status": "string"

}

Rename keyword group

get /groups/rename

https://www.spyfu.com:80/apis/my_spyfu_api/groups/rename

query Parameters

userId required	string <uuid> User's ID
projectId required	string <uuid> Project ID
groupHash required	integer <int64> Group ID
newGroupName required	string New group name
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/groups/rename?userId=USER_GUID&projectId=PROJECT_GUID&groupHash=1506559589241584998&newGroupName=Hot Leads&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"status": "string"

}

Remove keyword group from a project

get /groups/delete

https://www.spyfu.com:80/apis/my_spyfu_api/groups/delete

query Parameters

userId required	string <uuid> User's ID
projectId required	string <uuid> Project ID
groupHash required	integer <int64> Group ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/groups/delete?userId=USER_GUID&projectId=PROJECT_GUID&groupHash=1506559589241584998&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"groupHash": "string",
"groupName": "string",
"status": "string",
"termsCsv": "string"

}

Clone a keyword group under a new name

get /groups/clone

https://www.spyfu.com:80/apis/my_spyfu_api/groups/clone

query Parameters

userId required	string <uuid> User's ID
projectId required	string <uuid> Project ID
oldGroupHash required	integer <int64> Group ID to clone from
newGroupName required	string New group name
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/groups/clone?userId=USER_GUID&projectId=PROJECT_GUID&oldGroupHash=1506559589241584998&newGroupName=Hot Leads&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"groupHash": "string",
"status": "string"

}

Move keyword group from one project to another

get /groups/migrate

https://www.spyfu.com:80/apis/my_spyfu_api/groups/migrate

query Parameters

userId required	string <uuid> User's ID
oldProjectId required	string <uuid> Project ID to migrate from
newProjectId required	string <uuid> Project ID to migrate to
groupHash required	integer <int64> Group ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/groups/migrate?userId=USER_GUID&oldProjectId=PROJECT_GUID&newProjectId=PROJECT_GUID&groupHash=1506559589241584998&labelHash=-4149933402935822247&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"status": "string"

}

Move keywords from one group to another in the same project

post /groups/migrate_keywords_to_group

https://www.spyfu.com:80/apis/my_spyfu_api/groups/migrate_keywords_to_group

query Parameters

api_key

string

User's secret key

Request Body schema:
application/json

userId	string <uuid> User's ID
projectId	string <uuid> Project ID
newGroupHash	integer <int64> Group ID to migrate to
oldGroupHash	integer <int64> Group ID to migrate from
termIdsCsv	string Comma-separated term IDs

Responses

200

500

InternalServerError

Request samples

Payload
cURL
JS
C#
PHP

Content type

Copy

Expand all Collapse all

{

"userId": "string",
"projectId": "string",
"newGroupHash": 0,
"oldGroupHash": 0,
"termIdsCsv": "string"

}

Response samples

Content type

Copy

Expand all Collapse all

{

"newKeywordCount": 0,
"oldKeywordCount": 0

}

Remove keywords from a group

post /groups/remove_keywords_from_group

https://www.spyfu.com:80/apis/my_spyfu_api/groups/remove_keywords_from_group

query Parameters

api_key

string

User's secret key

Request Body schema:
application/json

userId	string <uuid> User's ID
projectId	string <uuid> Project ID
groupHash	integer <int64> Group ID
termIdsCsv	string Comma-separated term IDs

Responses

204

NoContent

500

InternalServerError

Request samples

Payload
cURL
JS
C#
PHP

Content type

Copy

Expand all Collapse all

{

"userId": "string",
"projectId": "string",
"groupHash": 0,
"termIdsCsv": "string"

}

Export all keywords attached to a group

get /groups/export

https://www.spyfu.com:80/apis/my_spyfu_api/groups/export

query Parameters

userId required	string <uuid> User's ID
projectId required	string <uuid> Project ID
groupHash required	integer <int64> Group ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/groups/export?userId=USER_GUID&projectId=PROJECT_GUID&groupHash=1506559589241584998&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

"string"

Get overview of keyword group metrics

get /groups/details

https://www.spyfu.com:80/apis/my_spyfu_api/groups/details

query Parameters

userId required	string <uuid> User's ID
projectId required	string <uuid> Project ID
groupHash required	integer <int64> Group ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/groups/details?userId=USER_GUID&projectId=PROJECT_GUID&groupHash=1506559589241584998&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"avgAdPosition": 0,
"avgAdPositionChange": 0,
"bothCount": 0,
"estClickChange": 0,
"estMonthlyClicks": 0,
"groupHash": 0,
"groupName": "string",
"impressionShare": 0,
"impressionShareChange": 0,
"improvedRanks": 0,
"lostRanks": 0,
"newlyRankedKeywords": 0,
"numberOfKeywords": 0,
"organicCount": 0,
"paidCount": 0,
"potentialClicks": 0,
"rankChange": 0,
"topOfPagePct": 0,
"topOfPagePctChange": 0,
"groupHistory":
[
- {
  - "avgAdPosition": 0,
  - "estMonthlyClicks": 0,
  - "impressionShare": 0,
  - "searchDateId": 0,
  - "sumOfRanks": 0,
  - "topOfPagePercentage": 0
  }
]

}

Get groups of top performance keywords based on domain

get /groups/get_performance_groups

https://www.spyfu.com:80/apis/my_spyfu_api/groups/get_performance_groups

query Parameters

domain required	string Domain query
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/groups/get_performance_groups?domain=spyfu.com&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"groups":
[
- {
  - "name": "string",
  - "key": "string",
  - "keywordCount": 0,
  - "keywords":
    [
    "string"
    ]
  }
]

}

KeywordLabelsApi

Read, create, update, and delete keyword labels for projects.

Get list of keyword labels for a project

get /labels/list

https://www.spyfu.com:80/apis/my_spyfu_api/labels/list

query Parameters

userId required	string <uuid> User's ID
projectId required	string <uuid> Project ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/labels/list?userId=USER_GUID&projectId=PROJECT_GUID&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "projectId": "string",
- "labelName": "string",
- "labelHash": "string",
- "termCount": 0
}

]

Add new keyword labels to a project

post /labels/add_keywords

https://www.spyfu.com:80/apis/my_spyfu_api/labels/add_keywords

query Parameters

api_key

string

User's secret key

Request Body schema:
application/json

userId	string <uuid> User's ID
projectId	string <uuid> Project ID
labelName	string Label name
termIdsCsv	string Comma-separated term IDs

Responses

200

500

InternalServerError

Request samples

Payload
cURL
JS
C#
PHP

Content type

Copy

Expand all Collapse all

{

"userId": "string",
"projectId": "string",
"labelName": "string",
"termIdsCsv": "string"

}

Response samples

Content type

Copy

Expand all Collapse all

{

"labelHash": "string",
"labeledTermIds":
[
- "string"
]

}

Remove a label from a list of keywords

post /labels/remove_keywords

https://www.spyfu.com:80/apis/my_spyfu_api/labels/remove_keywords

query Parameters

api_key

string

User's secret key

Request Body schema:
application/json

userId	string <uuid> User's ID
projectId	string <uuid> Project ID
labelName	string Label name
termIdsCsv	string Comma-separated term IDs

Responses

200

204

NoContent

500

InternalServerError

Request samples

Payload
cURL
JS
C#
PHP

Content type

Copy

Expand all Collapse all

{

"userId": "string",
"projectId": "string",
"labelName": "string",
"termIdsCsv": "string"

}

Response samples

Content type

Copy

Expand all Collapse all

{

"labelName": "string",
"termIdsCsv": "string"

}

Remove keyword labels from a project

post /labels/remove_labels

https://www.spyfu.com:80/apis/my_spyfu_api/labels/remove_labels

query Parameters

api_key

string

User's secret key

Request Body schema:
application/json

userId	string <uuid> User's ID
projectId	string <uuid> Project ID
labelHashesCsv	string Comma-separated label IDs

Responses

200

500

InternalServerError

Request samples

Payload
cURL
JS
C#
PHP

Content type

Copy

Expand all Collapse all

{

"userId": "string",
"projectId": "string",
"labelHashesCsv": "string"

}

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "labelHash": 0,
- "labelName": "string",
- "termIdsCsv": "string"
}

]

Export all keywords attached to a label

get /labels/export

https://www.spyfu.com:80/apis/my_spyfu_api/labels/export

query Parameters

userId required	string <uuid> User's ID
projectId required	string <uuid> Project ID
labelHash required	integer <int64> Label ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/labels/export?userId=USER_GUID&projectId=PROJECT_GUID&labelHash=-4149933402935822247&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

"string"

Rename keyword label

post /labels/rename

https://www.spyfu.com:80/apis/my_spyfu_api/labels/rename

query Parameters

api_key

string

User's secret key

Request Body schema:
application/json

userId	string <uuid> User's ID
projectId	string <uuid> Project ID
labelHash	integer <int64> Label ID to rename
newLabelName	string New name to rename label to

Responses

200

500

InternalServerError

Request samples

Payload
cURL
JS
C#
PHP

Content type

Copy

Expand all Collapse all

{

"userId": "string",
"projectId": "string",
"labelHash": 0,
"newLabelName": "string"

}

Response samples

Content type

Copy

Expand all Collapse all

{ }

DomainsApi

Read, create, update, and delete domains for project outreach campaigns.

Get list of domains for a project

get /domains/list

https://www.spyfu.com:80/apis/my_spyfu_api/domains/list

query Parameters

userId required	string <uuid> User's ID
projectId required	string <uuid> Project ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/domains/list?userId=USER_GUID&projectId=PROJECT_GUID&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "domainId": "string",
- "domainName": "string",
- "projectId": "string",
- "userRating": 0,
- "relationshipStatusId": 0,
- "leadsInfo":
  {
  - "domainId": 0,
  - "emails": "string",
  - "phones": "string",
  - "twitterAccounts": "string",
  - "facebookUrls": "string",
  - "pinterestUrls": "string",
  - "youtubeUrls": "string",
  - "linkedInUrls": "string",
  - "googlePlusUrls": "string"
  },
- "domainStrength": 0,
- "urlCount": 0,
- "tags":
  [
  - "string"
  ],
- "projectName": "string",
- "projectDomainName": "string"
}

]

Get specific domain from a project

get /domains/get

https://www.spyfu.com:80/apis/my_spyfu_api/domains/get

query Parameters

userId required	string <uuid> User's ID
projectId required	string <uuid> Project ID
domainId required	integer <int64> Domain ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/domains/get?userId=USER_GUID&projectId=PROJECT_GUID&domainId=DOMAIN_GUID&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"domainId": "string",
"domainName": "string",
"projectId": "string",
"userRating": 0,
"relationshipStatusId": 0,
"leadsInfo":
{
- "domainId": 0,
- "emails": "string",
- "phones": "string",
- "twitterAccounts": "string",
- "facebookUrls": "string",
- "pinterestUrls": "string",
- "youtubeUrls": "string",
- "linkedInUrls": "string",
- "googlePlusUrls": "string"
},
"domainStrength": 0,
"urlCount": 0,
"tags":
[
- "string"
],
"projectName": "string",
"projectDomainName": "string"

}

Export project domains as a CSV

get /domains/export

https://www.spyfu.com:80/apis/my_spyfu_api/domains/export

query Parameters

userId required	string <uuid> User's ID
projectId required	string <uuid> Project ID
websiteIdCsv	string WebsiteId CSV to filter by
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/domains/export?userId=USER_GUID&projectId=PROJECT_GUID&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

"string"

Removes a list of domains and all attached data from a project

put /domains/bulkdelete

https://www.spyfu.com:80/apis/my_spyfu_api/domains/bulkdelete

query Parameters

api_key

string

User's secret key

Request Body schema:
application/json

List of domains to remove

items	Array of objects (DomainReference) Domain-project pairs
userId	string <uuid> User's ID

Responses

200

500

InternalServerError

Request samples

Payload

Content type

Copy

Expand all Collapse all

{

"items":
[
- {
  - "domainId": 0,
  - "projectId": "string"
  }
],
"userId": "string"

}

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "domainId": "string",
- "status": "string"
}

]

Removes a domain and all attached data from a project

get /domains/delete

https://www.spyfu.com:80/apis/my_spyfu_api/domains/delete

query Parameters

userId required	string <uuid> User's ID
projectId required	string <uuid> Project ID
domainId required	integer <int64> Domain ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/domains/delete?userId=USER_GUID&projectId=PROJECT_GUID&domainId=DOMAIN_GUID&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"domainId": "string",
"status": "string"

}

Gets a list of associated contexts for a domain

get /domains/contexts

https://www.spyfu.com:80/apis/my_spyfu_api/domains/contexts

query Parameters

userId required	string <uuid> User's ID
domainId required	integer <int64> Domain ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/domains/contexts?userId=USER_GUID&domainId=DOMAIN_GUID&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

"string"

]

Updates a domain's personalized rating

get /domains/rating/update

https://www.spyfu.com:80/apis/my_spyfu_api/domains/rating/update

query Parameters

userId required	string <uuid> User's ID
projectId required	string <uuid> Project ID
domainId required	integer <int64> Domain ID
userRating required	integer <int32> Star rating (0-3)
api_key	string User's secret key

Responses

204

NoContent

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/domains/rating/update?userId=USER_GUID&projectId=PROJECT_GUID&domainId=DOMAIN_GUID&userRating=3&api_key=SECRET_KEY"

UrlsApi

Read, create, update, and delete urls for project outreach campaigns.

Get list of urls for a project domain

get /urls/list

https://www.spyfu.com:80/apis/my_spyfu_api/urls/list

query Parameters

userId required	string <uuid> User's ID
projectId required	string <uuid> Project ID
domainId	integer <int64> Domain ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/urls/list?userId=USER_GUID&projectId=PROJECT_GUID&domainId=DOMAIN_GUID&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "urlId": "string",
- "urlName": "string",
- "projectId": "string",
- "projectDomainName": "string",
- "projectName": "string",
- "domainId": "string",
- "userRating": 0,
- "relationshipStatusId": 0,
- "tags":
  [
  - "string"
  ],
- "urlMonthlyOrganicClicks": 0,
- "urlRankedKeywords": 0
}

]

Get specific url from a project domain

get /urls/get

https://www.spyfu.com:80/apis/my_spyfu_api/urls/get

query Parameters

userId required	string <uuid> User's ID
projectId required	string <uuid> Project ID
domainId	integer <int64> Domain ID
urlId	integer <int64> URL ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/urls/get?userId=USER_GUID&projectId=PROJECT_GUID&domainId=DOMAIN_GUID&urlId=8184723504097168719&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"urlId": "string",
"urlName": "string",
"projectId": "string",
"projectDomainName": "string",
"projectName": "string",
"domainId": "string",
"userRating": 0,
"relationshipStatusId": 0,
"tags":
[
- "string"
],
"urlMonthlyOrganicClicks": 0,
"urlRankedKeywords": 0

}

Export project urls as a CSV

get /urls/export

https://www.spyfu.com:80/apis/my_spyfu_api/urls/export

query Parameters

userId required	string <uuid> User's ID
projectId required	string <uuid> Project ID
linkIdCsv	string LinkId CSV to filter by
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/urls/export?userId=USER_GUID&projectId=PROJECT_GUID&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

"string"

Attach a new url to a project domain

get /urls/create

https://www.spyfu.com:80/apis/my_spyfu_api/urls/create

query Parameters

userId required	string <uuid> User's ID
fullUrl required	string Fully qualified URL (e.g., https://www.spyfu.com/)
projectId required	string <uuid> Project ID
linksToIdOrQuery required	string Associated domain, url, or term query
linksToType required	string Associated type used by [linksToIdOrQuery]: (Domain, Url, Term)
filterTerm required	string Filter by term
backlinkType required	string Type of URL: (directory, govedu, forum, news, blog, affiliate, uncategorized)
competitorDomains required	string Associated competitors
pageMonthlyOrganicClicks required	integer <int32> Monthly organic clicks
rankedKeywords required	integer <int32> Number of ranked keywords
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/urls/create?userId=USER_GUID&projectId=PROJECT_GUID&fullUrl=https://www.spyfu.com/blog/&linksToIdOrQuery=spyfu.com&linksToType=Domain&filterTerm=keyword tool&backlinkType=Blog&competitorDomains=spyfoo.com&pageMonthlyOrganicClicks=500&rankedKeywords=15&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"domainId": "string",
"urlId": "string",
"status": "string"

}

Removes a list of links from a project

put /urls/bulkdelete

https://www.spyfu.com:80/apis/my_spyfu_api/urls/bulkdelete

query Parameters

api_key

string

User's secret key

Request Body schema:
application/json

List of URL IDs to remove

items	Array of objects (LinkReference) URL-project pairs
userId	string <uuid> User's ID

Responses

200

500

InternalServerError

Request samples

Payload

Content type

Copy

Expand all Collapse all

{

"items":
[
- {
  - "urlId": 0,
  - "projectId": "string"
  }
],
"userId": "string"

}

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "urlId": "string",
- "status": "string"
}

]

Detach an existing url from a project domain

get /urls/delete

https://www.spyfu.com:80/apis/my_spyfu_api/urls/delete

query Parameters

userId required	string <uuid> User's ID
projectId required	string <uuid> Project ID
urlId required	integer <int64> URL ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/urls/delete?userId=USER_GUID&projectId=PROJECT_GUID&urlId=8184723504097168719&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"urlId": "string",
"status": "string"

}

Gets a list of associated contexts for a url

get /urls/contexts

https://www.spyfu.com:80/apis/my_spyfu_api/urls/contexts

query Parameters

userId required	string <uuid> User's ID
domainId required	integer <int64> Domain ID
urlId required	integer <int64> URL ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/urls/contexts?userId=USER_GUID&projectId=PROJECT_GUID&domainId=DOMAIN_GUID&urlId=8184723504097168719&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

"string"

]

Updates a url's personalized rating

get /urls/rating/update

https://www.spyfu.com:80/apis/my_spyfu_api/urls/rating/update

query Parameters

userId required	string <uuid> User's ID
projectId required	string <uuid> Project ID
urlId required	integer <int64> URL ID
domainId required	integer <int64> Domain ID
userRating required	integer <int32> Star rating (0-3)
api_key	string User's secret key

Responses

204

NoContent

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/urls/rating/update?userId=USER_GUID&projectId=PROJECT_GUID&domainId=DOMAIN_GUID&urlId=8184723504097168719&userRating=3&api_key=SECRET_KEY"

ConfirmedContactsApi

Confirmed contacts associated with a project.

Get all distinct Confirmed Contacts for a userId

get /confirmedcontacts/list

https://www.spyfu.com:80/apis/my_spyfu_api/confirmedcontacts/list

query Parameters

userId required	string <uuid> User's ID
projectId required	string <uuid> Project ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/confirmedcontacts/list?userId=USER_GUID&projectId=PROJECT_GUID&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "contactId": "string",
- "projectId": "string",
- "domainId": "string",
- "imageUrl": "string",
- "firstName": "string",
- "lastName": "string",
- "fullName": "string",
- "userRating": 0,
- "klout": 0,
- "spyfluence": 0,
- "relationshipStatusId": 0,
- "relationshipStatus": "string",
- "tags":
  [
  - "string"
  ],
- "contactDetails":
  {
  - "emailAddress": "string",
  - "twitterUrl": "string",
  - "facebookUrl": "string",
  - "googlePlusUrl": "string",
  - "linkedInUrl": "string",
  - "pinterestUrl": "string",
  - "hasFacebook": true,
  - "hasTwitter": true,
  - "hasGooglePlus": true,
  - "hasLinkedIn": true
  }
}

]

Get a list of Confirmed Contacts for a Domain

get /confirmedcontacts/domain/list

https://www.spyfu.com:80/apis/my_spyfu_api/confirmedcontacts/domain/list

query Parameters

userId required	string <uuid> User's ID
projectId required	string <uuid> Project ID
domainId required	integer <int64> Domain ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/confirmedcontacts/domain/list?userId=USER_GUID&projectId=PROJECT_GUID&domainId=DOMAIN_GUID&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "contactId": "string",
- "domainId": "string",
- "projectId": "string",
- "imageUrl": "string",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "emailAddress": "string",
- "linkedInUrl": "string",
- "facebookUrl": "string",
- "twitterUrl": "string",
- "googlePlusUrl": "string",
- "hasFacebook": true,
- "hasTwitter": true,
- "hasGooglePlus": true,
- "hasLinkedIn": true,
- "klout": 0,
- "spyfluence": 0,
- "userRating": 0,
- "relationshipStatus": "string",
- "relationshipStatusId": 0,
- "title": "string",
- "company": "string",
- "linkedInBio": "string",
- "facebookBio": "string",
- "twitterBio": "string",
- "googlePlusBio": "string"
}

]

Get a list of Confirmed Contacts for a Link

get /confirmedcontacts/url/list

https://www.spyfu.com:80/apis/my_spyfu_api/confirmedcontacts/url/list

query Parameters

userId required	string <uuid> User's ID
projectId required	string <uuid> Project ID
domainId required	integer <int64> Domain ID
urlId required	integer <int64> URL ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/confirmedcontacts/url/list?userId=USER_GUID&projectId=PROJECT_GUID&domainId=DOMAIN_GUID&urlId=8184723504097168719&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "contactId": "string",
- "domainId": "string",
- "projectId": "string",
- "imageUrl": "string",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "emailAddress": "string",
- "linkedInUrl": "string",
- "facebookUrl": "string",
- "twitterUrl": "string",
- "googlePlusUrl": "string",
- "hasFacebook": true,
- "hasTwitter": true,
- "hasGooglePlus": true,
- "hasLinkedIn": true,
- "klout": 0,
- "spyfluence": 0,
- "userRating": 0,
- "relationshipStatus": "string",
- "relationshipStatusId": 0,
- "title": "string",
- "company": "string",
- "linkedInBio": "string",
- "facebookBio": "string",
- "twitterBio": "string",
- "googlePlusBio": "string"
}

]

Get Contact Details (Confirmed Contact)

get /confirmedcontacts/get

https://www.spyfu.com:80/apis/my_spyfu_api/confirmedcontacts/get

query Parameters

userId required	string <uuid> User's ID
contactId required	integer <int64> Confirmed contact ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/confirmedcontacts/get?userId=USER_GUID&contactId=-2719115600493040594&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"id": "string",
"firstName": "string",
"lastName": "string",
"photoUrl": "string",
"tags": "string",
"rating": 0,
"relationshipStatus": "string",
"relationshipStatusId": 0,
"companyName": "string",
"title": "string",
"spyFluence": "string",
"klout": "string",
"organizationRowId": "string"

}

Create a contact

get /confirmedcontacts/create

https://www.spyfu.com:80/apis/my_spyfu_api/confirmedcontacts/create

query Parameters

userId required	string <uuid> User's ID
projectId	string <uuid> Project ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/confirmedcontacts/create?userId=USER_GUID&projectId=PROJECT_GUID&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"contactId": "string",
"projectId": "string",
"domainId": "string",
"imageUrl": "string",
"firstName": "string",
"lastName": "string",
"fullName": "string",
"userRating": 0,
"klout": 0,
"spyfluence": 0,
"relationshipStatusId": 0,
"relationshipStatus": "string",
"tags":
[
- "string"
],
"contactDetails":
{
- "emailAddress": "string",
- "twitterUrl": "string",
- "facebookUrl": "string",
- "googlePlusUrl": "string",
- "linkedInUrl": "string",
- "pinterestUrl": "string",
- "hasFacebook": true,
- "hasTwitter": true,
- "hasGooglePlus": true,
- "hasLinkedIn": true
}

}

Create a contact associated with a domain

get /confirmedcontacts/domain/create

https://www.spyfu.com:80/apis/my_spyfu_api/confirmedcontacts/domain/create

query Parameters

userId required	string <uuid> User's ID
projectId required	string <uuid> Project ID
domainId required	integer <int64> Domain ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/confirmedcontacts/domain/create?userId=USER_GUID&projectId=PROJECT_GUID&domainId=DOMAIN_GUID&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"contactId": "string",
"projectId": "string",
"domainId": "string",
"imageUrl": "string",
"firstName": "string",
"lastName": "string",
"fullName": "string",
"userRating": 0,
"klout": 0,
"spyfluence": 0,
"relationshipStatusId": 0,
"relationshipStatus": "string",
"tags":
[
- "string"
],
"contactDetails":
{
- "emailAddress": "string",
- "twitterUrl": "string",
- "facebookUrl": "string",
- "googlePlusUrl": "string",
- "linkedInUrl": "string",
- "pinterestUrl": "string",
- "hasFacebook": true,
- "hasTwitter": true,
- "hasGooglePlus": true,
- "hasLinkedIn": true
}

}

Create a contact associated with a link

get /confirmedcontacts/url/create

https://www.spyfu.com:80/apis/my_spyfu_api/confirmedcontacts/url/create

query Parameters

userId required	string <uuid> User's ID
projectId required	string <uuid> Project ID
domainId required	integer <int64> Domain ID
urlId required	integer <int64> URL ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/confirmedcontacts/url/create?userId=USER_GUID&projectId=PROJECT_GUID&domainId=DOMAIN_GUID&urlId=8184723504097168719&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"contactId": "string",
"projectId": "string",
"domainId": "string",
"imageUrl": "string",
"firstName": "string",
"lastName": "string",
"fullName": "string",
"userRating": 0,
"klout": 0,
"spyfluence": 0,
"relationshipStatusId": 0,
"relationshipStatus": "string",
"tags":
[
- "string"
],
"contactDetails":
{
- "emailAddress": "string",
- "twitterUrl": "string",
- "facebookUrl": "string",
- "googlePlusUrl": "string",
- "linkedInUrl": "string",
- "pinterestUrl": "string",
- "hasFacebook": true,
- "hasTwitter": true,
- "hasGooglePlus": true,
- "hasLinkedIn": true
}

}

Delete a contact

get /confirmedcontacts/delete

https://www.spyfu.com:80/apis/my_spyfu_api/confirmedcontacts/delete

query Parameters

userId required	string <uuid> User's ID
contactId required	integer <int64> Confirmed contact ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/confirmedcontacts/delete?userId=USER_GUID&contactId=-2719115600493040594&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"contactId": 0,
"status": "string"

}

Delete a list of contacts from a project

put /confirmedcontacts/batchdelete

https://www.spyfu.com:80/apis/my_spyfu_api/confirmedcontacts/batchdelete

query Parameters

api_key

string

User's secret key

Request Body schema:
application/json

List of contacts to remove from associated projects

items	Array of objects (ContactReference) Contact-project pairs
userId	string <uuid> User's ID

Responses

200

500

InternalServerError

Request samples

Payload

Content type

Copy

Expand all Collapse all

{

"items":
[
- {
  - "contactId": 0,
  - "projectId": "string"
  }
],
"userId": "string"

}

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "contactId": 0,
- "status": "string"
}

]

Edit a contacts details

get /confirmedcontacts/update

https://www.spyfu.com:80/apis/my_spyfu_api/confirmedcontacts/update

query Parameters

userId required	string <uuid> User's ID
contactId required	integer <int64> Confirmed contact ID
organizationRowId required	integer <int64> Contact's company ID
firstName required	string Contact's first name
lastName required	string Contact's last name
title required	string Contact's job title
companyName required	string Contact's compay name
api_key	string User's secret key

Responses

204

NoContent

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/confirmedcontacts/update?userId=USER_GUID&contactId=-2719115600493040594&organizationRowId=1&firstName=James&lastName=Bond&title=International Man of Mystery&companyName=MI6&api_key=SECRET_KEY"

Migrate contact to a different project

get /confirmedcontacts/migrate

https://www.spyfu.com:80/apis/my_spyfu_api/confirmedcontacts/migrate

query Parameters

userId required	string <uuid>
contactId required	integer <int64>
oldProjectId required	string <uuid>
newProjectId required	string <uuid>
api_key	string User's secret key

Responses

200

Response samples

Content type

Copy

Expand all Collapse all

{

"property1": { },
"property2": { }

}

Get Contact Related Website (Confirmed Contact)

get /confirmedcontacts/relatedlinks/list

https://www.spyfu.com:80/apis/my_spyfu_api/confirmedcontacts/relatedlinks/list

query Parameters

userId required	string <uuid> User's ID
contactId required	integer <int64> Confirmed contact ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/confirmedcontacts/relatedlinks/list?userId=USER_GUID&contactId=-2719115600493040594&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "relatedLink": "string",
- "linkType": "string",
- "domainId": "string",
- "urlId": "string",
- "rating": 0,
- "status": 0
}

]

Get Contact Websites (Confirmed Contact)

get /confirmedcontacts/websites/list

https://www.spyfu.com:80/apis/my_spyfu_api/confirmedcontacts/websites/list

query Parameters

userId required	string <uuid> User's ID
contactId required	integer <int64> Confirmed contact ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/confirmedcontacts/websites/list?userId=USER_GUID&contactId=-2719115600493040594&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "contactId": "string",
- "website": "string",
- "websiteRowId": "string"
}

]

Add a website to a contact

get /confirmedcontacts/websites/create

https://www.spyfu.com:80/apis/my_spyfu_api/confirmedcontacts/websites/create

query Parameters

userId required	string <uuid> User's ID
contactId required	integer <int64> Confirmed contact ID
website required	string Associated website URL
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/confirmedcontacts/websites/create?userId=USER_GUID&contactId=-2719115600493040594&website=spyfu.com&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"contactId": "string",
"website": "string",
"websiteRowId": "string"

}

Edit a website for a contact

get /confirmedcontacts/websites/update

https://www.spyfu.com:80/apis/my_spyfu_api/confirmedcontacts/websites/update

query Parameters

userId required	string <uuid> User's ID
contactId required	integer <int64> Confirmed contact ID
website required	string Associated website URL
websiteRowId required	integer <int64> Associated website ID
api_key	string User's secret key

Responses

204

NoContent

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/confirmedcontacts/websites/update?userId=USER_GUID&contactId=-2719115600493040594&website=spyfu.com&websiteRowId=1&api_key=SECRET_KEY"

Delete a website from a contact

get /confirmedcontacts/websites/delete

https://www.spyfu.com:80/apis/my_spyfu_api/confirmedcontacts/websites/delete

query Parameters

userId required	string <uuid> User's ID
websiteRowId required	integer <int64> Associated website ID
api_key	string User's secret key

Responses

204

NoContent

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/confirmedcontacts/websites/delete?userId=USER_GUID&websiteRowId=1&api_key=SECRET_KEY"

Get Contact Phones (Confirmed Contact)

get /confirmedcontacts/phones/list

https://www.spyfu.com:80/apis/my_spyfu_api/confirmedcontacts/phones/list

query Parameters

userId required	string <uuid> User's ID
contactId required	integer <int64> Confirmed contact ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/confirmedcontacts/phones/list?userId=USER_GUID&contactId=-2719115600493040594&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "contactId": "string",
- "phoneNumber": "string",
- "phoneType": "string",
- "phoneRowId": "string"
}

]

Add a phone for a contact

get /confirmedcontacts/phones/create

https://www.spyfu.com:80/apis/my_spyfu_api/confirmedcontacts/phones/create

query Parameters

userId required	string <uuid> User's ID
contactId required	integer <int64> Confirmed contact ID
phoneNumber required	string Associated phone number
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/confirmedcontacts/phones/create?userId=USER_GUID&contactId=-2719115600493040594&phoneNumber=1-888-123-4567&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"contactId": "string",
"phoneNumber": "string",
"phoneType": "string",
"phoneRowId": "string"

}

Edit a phone for a contact

get /confirmedcontacts/phones/update

https://www.spyfu.com:80/apis/my_spyfu_api/confirmedcontacts/phones/update

query Parameters

userId required	string <uuid> User's ID
contactId required	integer <int64> Confirmed contact ID
phoneNumber required	string Associated phone number
phoneRowId required	integer <int64> Associated phone number ID
api_key	string User's secret key

Responses

204

NoContent

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/confirmedcontacts/phones/update?userId=USER_GUID&contactId=-2719115600493040594&phoneNumber=1-888-123-4567&phoneRowId=1&api_key=SECRET_KEY"

Delete a phone from a contact

get /confirmedcontacts/phones/delete

https://www.spyfu.com:80/apis/my_spyfu_api/confirmedcontacts/phones/delete

query Parameters

userId required	string <uuid> User's ID
phoneRowId required	integer <int64> Associated phone number ID
api_key	string User's secret key

Responses

204

NoContent

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/confirmedcontacts/phones/delete?userId=USER_GUID&phoneRowId=1&api_key=SECRET_KEY"

Get Contact Social Media (Confirmed Contact)

get /confirmedcontacts/socialmedia/list

https://www.spyfu.com:80/apis/my_spyfu_api/confirmedcontacts/socialmedia/list

query Parameters

userId required	string <uuid> User's ID
contactId required	integer <int64> Confirmed contact ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/confirmedcontacts/socialmedia/list?userId=USER_GUID&contactId=-2719115600493040594&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "id": "string",
- "bio": "string",
- "contactId": "string",
- "accountUrl": "string",
- "accountName": "string",
- "type": "string",
- "followerCount": 0
}

]

Add a social media profile for a contact

get /confirmedcontacts/socialmedia/create

https://www.spyfu.com:80/apis/my_spyfu_api/confirmedcontacts/socialmedia/create

query Parameters

userId required	string <uuid> User's ID
contactId required	integer <int64> Confirmed contact ID
accountUrl required	string Associated social media account URL
type required	string Type of social media: (Email, Facebook, Twitter, LinkedIn, GooglePlus, YouTube)
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/confirmedcontacts/socialmedia/create?userId=USER_GUID&contactId=-2719115600493040594&accountUrl=example@spyfu.com&type=Email&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"id": "string",
"bio": "string",
"contactId": "string",
"accountUrl": "string",
"accountName": "string",
"type": "string",
"followerCount": 0

}

Delete a social media profile from a contact

get /confirmedcontacts/socialmedia/delete

https://www.spyfu.com:80/apis/my_spyfu_api/confirmedcontacts/socialmedia/delete

query Parameters

userId required	string <uuid> User's ID
profileRowId required	integer <int64> Associated social media account ID
api_key	string User's secret key

Responses

204

NoContent

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/confirmedcontacts/socialmedia/delete?userId=USER_GUID&profileRowId=1&api_key=SECRET_KEY"

Delete an email from a contact

get /confirmedcontacts/email/delete

https://www.spyfu.com:80/apis/my_spyfu_api/confirmedcontacts/email/delete

query Parameters

userId required	string <uuid> User's ID
emailRowId required	integer <int64> Associated email ID
api_key	string User's secret key

Responses

204

NoContent

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/confirmedcontacts/email/delete?userId=USER_GUID&emailRowId=1&api_key=SECRET_KEY"

Update the rating for a confirmed contact

get /confirmedcontacts/rating/update

https://www.spyfu.com:80/apis/my_spyfu_api/confirmedcontacts/rating/update

query Parameters

userId required	string <uuid> User's ID
contactId required	integer <int64> Confirmed contact ID
userRating required	integer <int32> Star rating (0-3)
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/confirmedcontacts/rating/update?userId=USER_GUID&contactId=-2719115600493040594&userRating=3&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"status": "string"

}

DiscoveredContactsApi

Discovered potential contacts for domains and URLs.

Get a list of Discovered Contacts for a Domain

get /discoveredcontacts/domain/get

https://www.spyfu.com:80/apis/my_spyfu_api/discoveredcontacts/domain/get

query Parameters

userId required	string <uuid> User's ID
projectId required	string <uuid> Project ID
domainId required	integer <int64> Domain ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/discoveredcontacts/domain/get?userId=USER_GUID&projectId=PROJECT_GUID&domainId=DOMAIN_GUID&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "contactId": "string",
- "domainId": "string",
- "projectId": "string",
- "imageUrl": "string",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "emailAddress": "string",
- "linkedInUrl": "string",
- "facebookUrl": "string",
- "twitterUrl": "string",
- "googlePlusUrl": "string",
- "hasFacebook": true,
- "hasTwitter": true,
- "hasGooglePlus": true,
- "hasLinkedIn": true,
- "klout": 0,
- "spyfluence": 0,
- "userRating": 0,
- "relationshipStatus": "string",
- "relationshipStatusId": 0,
- "title": "string",
- "company": "string",
- "linkedInBio": "string",
- "facebookBio": "string",
- "twitterBio": "string",
- "googlePlusBio": "string"
}

]

Get a list of Discovered Contacts for a Link

get /discoveredcontacts/url/get

https://www.spyfu.com:80/apis/my_spyfu_api/discoveredcontacts/url/get

query Parameters

userId required	string <uuid> User's ID
projectId required	string <uuid> Project ID
domainId required	integer <int64> Domain ID
urlId required	integer <int64> URL ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/discoveredcontacts/url/get?userId=USER_GUID&projectId=PROJECT_GUID&domainId=DOMAIN_GUID&urlId=8184723504097168719&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "contactId": "string",
- "domainId": "string",
- "projectId": "string",
- "imageUrl": "string",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "emailAddress": "string",
- "linkedInUrl": "string",
- "facebookUrl": "string",
- "twitterUrl": "string",
- "googlePlusUrl": "string",
- "hasFacebook": true,
- "hasTwitter": true,
- "hasGooglePlus": true,
- "hasLinkedIn": true,
- "klout": 0,
- "spyfluence": 0,
- "userRating": 0,
- "relationshipStatus": "string",
- "relationshipStatusId": 0,
- "title": "string",
- "company": "string",
- "linkedInBio": "string",
- "facebookBio": "string",
- "twitterBio": "string",
- "googlePlusBio": "string"
}

]

Confirm a Suggested Contact for a Domain

get /discoveredcontacts/domain/confirm

https://www.spyfu.com:80/apis/my_spyfu_api/discoveredcontacts/domain/confirm

query Parameters

userId required	string <uuid> User's ID
projectId required	string <uuid> Project ID
contactId required	integer <int64> Discovered contact ID
domainId required	integer <int64> Domain ID
api_key	string User's secret key

Responses

204

NoContent

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/discoveredcontacts/domain/confirm?userId=USER_GUID&projectId=PROJECT_GUID&contactId=-2719115600493040594&domainId=DOMAIN_GUID&api_key=SECRET_KEY"

Confirm a Suggested Contact for a Link

get /discoveredcontacts/url/confirm

https://www.spyfu.com:80/apis/my_spyfu_api/discoveredcontacts/url/confirm

query Parameters

userId required	string <uuid> User's ID
projectId required	string <uuid> Project ID
contactId required	integer <int64> Discovered contact ID
domainId required	integer <int64> Domain ID
urlId required	integer <int64> URL ID
api_key	string User's secret key

Responses

204

NoContent

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/discoveredcontacts/url/confirm?userId=USER_GUID&projectId=PROJECT_GUID&contactId=-2719115600493040594&domainId=DOMAIN_GUID&urlId=8184723504097168719&api_key=SECRET_KEY"

ImportApi

Bulk import new items into projects.

Import list of line-separated domains/links into a project

post /import/outreach

https://www.spyfu.com:80/apis/my_spyfu_api/import/outreach

query Parameters

api_key

string

User's secret key

Request Body schema:
application/json

List of domains/links and associated data

userId	string <uuid> User's ID
projectId	string <uuid> Project ID
importItemsLsv	string Line-separated list of domains or links
tagCsv	string Comma-separated tags to add to each item
userRating	integer <int32> Star rating (0-3) to attach to each item
relationshipStatusId	integer <int32> Relationship status to attach to each item: (0 = "Research: Not Yet Started", 1 = "Research: Under Review", 2 = "Research: Assigned", 3 = "Contact: Sent, Awaiting Response", 4 = "Contact: Need to Reply", 5 = "Contact: Link Accepted", 6 = "Issue: Contact Info Insufficient", 7 = "Issue: Not Possible", 8 = "Issue: Rejected", 9 = "Issue: See Notes", 10 = "Issue: Inactive", 11 = "Directory: Need to Submit", 12 = "Directory: Submitted")
note	string Custom note to attach to each item

Responses

200

500

InternalServerError

Request samples

Payload
cURL
JS
C#
PHP

Content type

Copy

Expand all Collapse all

{

"userId": "string",
"projectId": "string",
"importItemsLsv": "string",
"tagCsv": "string",
"userRating": 0,
"relationshipStatusId": 0,
"note": "string"

}

Response samples

Content type

Copy

Expand all Collapse all

{

"approvedDomains":
[
- {
  - "domainId": "string",
  - "urlId": "string",
  - "uriName": "string"
  }
],
"approvedUrls":
[
- {
  - "domainId": "string",
  - "urlId": "string",
  - "uriName": "string"
  }
],
"rejectedItems":
[
- {
  - "domainId": "string",
  - "urlId": "string",
  - "uriName": "string"
  }
],
"discoveredContacts":
[
- {
  - "contactId": "string"
  }
],
"defaultTag": "string",
"projectId": "string"

}

RelationshipsApi

Manage outreach workflow from first contact to successful arrangements.

Get list of project relationship status types

get /relationships/list

https://www.spyfu.com:80/apis/my_spyfu_api/relationships/list

query Parameters

api_key

string

User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/relationships/list?api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "id": 0,
- "status": "string"
}

]

Update the user's relationship status for a project domain

get /relationships/domain/update

https://www.spyfu.com:80/apis/my_spyfu_api/relationships/domain/update

query Parameters

userId required	string <uuid> User's ID
projectId required	string <uuid> Project ID
domainId required	integer <int64> Domain ID
relationshipStatusId required	integer <int32> Relationship status to attach to each item: (0 = "Research: Not Yet Started", 1 = "Research: Under Review", 2 = "Research: Assigned", 3 = "Contact: Sent, Awaiting Response", 4 = "Contact: Need to Reply", 5 = "Contact: Link Accepted", 6 = "Issue: Contact Info Insufficient", 7 = "Issue: Not Possible", 8 = "Issue: Rejected", 9 = "Issue: See Notes", 10 = "Issue: Inactive", 11 = "Directory: Need to Submit", 12 = "Directory: Submitted")
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/relationships/domain/update?userId=USER_GUID&projectId=PROJECT_GUID&domainId=DOMAIN_GUID&relationshipStatusId=1&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"status": "string"

}

Update the user's relationship status for a project url

get /relationships/url/update

https://www.spyfu.com:80/apis/my_spyfu_api/relationships/url/update

query Parameters

userId required	string <uuid> User's ID
projectId required	string <uuid> Project ID
domainId required	integer <int64> Domain ID
urlId required	integer <int64> URL ID
relationshipStatusId required	integer <int32> Relationship status to attach to each item: (0 = "Research: Not Yet Started", 1 = "Research: Under Review", 2 = "Research: Assigned", 3 = "Contact: Sent, Awaiting Response", 4 = "Contact: Need to Reply", 5 = "Contact: Link Accepted", 6 = "Issue: Contact Info Insufficient", 7 = "Issue: Not Possible", 8 = "Issue: Rejected", 9 = "Issue: See Notes", 10 = "Issue: Inactive", 11 = "Directory: Need to Submit", 12 = "Directory: Submitted")
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/relationships/url/update?userId=USER_GUID&projectId=PROJECT_GUID&domainId=DOMAIN_GUID&urlId=8184723504097168719&relationshipStatusId=1&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"status": "string"

}

Update the user's relationship status for a contact

get /relationships/contact/update

https://www.spyfu.com:80/apis/my_spyfu_api/relationships/contact/update

query Parameters

userId required	string <uuid> User's ID
contactId required	integer <int64> Contact ID
relationshipStatusId required	integer <int32> Relationship status to attach to each item: (0 = "Research: Not Yet Started", 1 = "Research: Under Review", 2 = "Research: Assigned", 3 = "Contact: Sent, Awaiting Response", 4 = "Contact: Need to Reply", 5 = "Contact: Link Accepted", 6 = "Issue: Contact Info Insufficient", 7 = "Issue: Not Possible", 8 = "Issue: Rejected", 9 = "Issue: See Notes", 10 = "Issue: Inactive", 11 = "Directory: Need to Submit", 12 = "Directory: Submitted")
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/relationships/contact/update?userId=USER_GUID&projectId=PROJECT_GUID&contactId=-2719115600493040594&relationshipStatusId=1&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"status": "string"

}

NotesApi

Read, create, and delete notes for outreach targets.

Gets a list of notes for a domain

get /notes/domain/list

https://www.spyfu.com:80/apis/my_spyfu_api/notes/domain/list

query Parameters

userId required	string <uuid> User's ID
domainId required	integer <int64> Domain ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/notes/domain/list?userId=USER_GUID&domainId=DOMAIN_GUID&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "noteText": "string",
- "dateCreated": "2025-06-14T19:54:00Z",
- "noteId": 0,
- "domainId": "string",
- "urlId": "string"
}

]

Gets a list of notes for a link

get /notes/url/list

https://www.spyfu.com:80/apis/my_spyfu_api/notes/url/list

query Parameters

userId required	string <uuid> User's ID
domainId required	integer <int64> Domain ID
urlId required	integer <int64> URL ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/notes/url/list?userId=USER_GUID&domainId=DOMAIN_GUID&urlId=8184723504097168719&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "noteText": "string",
- "dateCreated": "2025-06-14T19:54:00Z",
- "noteId": 0,
- "domainId": "string",
- "urlId": "string"
}

]

Gets a list of notes for a contact

get /notes/contact/list

https://www.spyfu.com:80/apis/my_spyfu_api/notes/contact/list

query Parameters

userId required	string <uuid> User's ID
contactId required	integer <int64> Contact ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/notes/contact/list?userId=USER_GUID&contactId=-2719115600493040594&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "noteText": "string",
- "dateCreated": "2025-06-14T19:54:00Z",
- "noteId": 0,
- "contactId": "string"
}

]

Create a note for a domain

get /notes/domain/create

https://www.spyfu.com:80/apis/my_spyfu_api/notes/domain/create

query Parameters

userId required	string <uuid> User's ID
note required	string Custom note
domainId required	integer <int64> Domain ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/notes/domain/create?userId=USER_GUID&note=Review by end of business day.&domainId=DOMAIN_GUID&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"noteText": "string",
"dateCreated": "2025-06-14T19:54:00Z",
"noteId": 0,
"domainId": "string",
"urlId": "string"

}

Create a note for a link

get /notes/url/create

https://www.spyfu.com:80/apis/my_spyfu_api/notes/url/create

query Parameters

userId required	string <uuid> User's ID
note required	string Custom note
domainId required	integer <int64> Domain ID
urlId required	integer <int64> URL ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/notes/url/create?userId=USER_GUID&note=Review by end of business day.&projectId=PROJECT_GUID&domainId=DOMAIN_GUID&urlId=8184723504097168719&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"noteText": "string",
"dateCreated": "2025-06-14T19:54:00Z",
"noteId": 0,
"domainId": "string",
"urlId": "string"

}

Create a note for a contact

get /notes/contact/create

https://www.spyfu.com:80/apis/my_spyfu_api/notes/contact/create

query Parameters

userId required	string <uuid> User's ID
note required	string Custom note
contactId required	integer <int64> Contact ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/notes/contact/create?userId=USER_GUID&note=Review by end of business day.&contactId=-2719115600493040594&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"noteText": "string",
"dateCreated": "2025-06-14T19:54:00Z",
"noteId": 0,
"contactId": "string"

}

Delete a note for a domain or url

get /notes/domain/delete

https://www.spyfu.com:80/apis/my_spyfu_api/notes/domain/delete

query Parameters

userId required	string <uuid> User's ID
noteRowId required	integer <int64> Note ID
api_key	string User's secret key

Responses

204

NoContent

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/notes/domain/delete?userId=USER_GUID&noteRowId=1&api_key=SECRET_KEY"

Delete a note for a contact

get /notes/contact/delete

https://www.spyfu.com:80/apis/my_spyfu_api/notes/contact/delete

query Parameters

userId required	string <uuid> User's ID
noteRowId required	integer <int64> Note ID
api_key	string User's secret key

Responses

204

NoContent

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/notes/contact/delete?userId=USER_GUID&noteRowId=1&api_key=SECRET_KEY"

TagsApi

Read and update tagging for outreach targets.

Gets a list of tags for a domain (domainId), url (domainId and urlId), or contact (contactId)

get /tags/list

https://www.spyfu.com:80/apis/my_spyfu_api/tags/list

query Parameters

userId required	string <uuid> User's ID
domainId	integer <int64> Domain ID
urlId	integer <int64> URL ID
contactId	integer <int64> Contact ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/tags/list?userId=USER_GUID&domainId=DOMAIN_GUID&urlId=8184723504097168719&contactId=-2719115600493040594&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"id": 0,
"domainId": "string",
"urlId": "string",
"contactId": "string",
"tagsCsv": "string"

}

Updates a list of tags for a domain (domainId), url (domainId and urlId), or contact (contactId)

get /tags/update

https://www.spyfu.com:80/apis/my_spyfu_api/tags/update

query Parameters

userId required	string <uuid> User's ID
tagsCsv required	string Comma-separated string of tags
domainId	integer <int64> Domain ID
urlId	integer <int64> URL ID
contactId	integer <int64> Contact ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/tags/update?userId=USER_GUID&tagsCsv=Review,Reach Out&domainId=DOMAIN_GUID&urlId=8184723504097168719&contactId=-2719115600493040594&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"id": 0,
"domainId": "string",
"urlId": "string",
"contactId": "string",
"tagsCsv": "string"

}

TasksApi

Read, create, update, and delete tasks for outreach targets.

Get tasks for a domain

get /tasks/domain/list

https://www.spyfu.com:80/apis/my_spyfu_api/tasks/domain/list

query Parameters

userId required	string <uuid> User's ID
domainId required	integer <int64> Domain ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/tasks/domain/list?userId=USER_GUID&domainId=DOMAIN_GUID&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "description": "string",
- "isCompleted": true,
- "taskId": 0,
- "dateCreated": "2025-06-14T19:54:00Z",
- "dateDue": "2025-06-14T19:54:00Z"
}

]

Get tasks for a url

get /tasks/url/list

https://www.spyfu.com:80/apis/my_spyfu_api/tasks/url/list

query Parameters

userId required	string <uuid> User's ID
domainId required	integer <int64> Domain ID
urlId required	integer <int64> URL ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/tasks/url/list?userId=USER_GUID&domainId=DOMAIN_GUID&urlId=8184723504097168719&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "description": "string",
- "isCompleted": true,
- "taskId": 0,
- "dateCreated": "2025-06-14T19:54:00Z",
- "dateDue": "2025-06-14T19:54:00Z"
}

]

Get tasks for a contact

get /tasks/contact/list

https://www.spyfu.com:80/apis/my_spyfu_api/tasks/contact/list

query Parameters

userId required	string <uuid> User's ID
contactId required	integer <int64> Contact ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/tasks/contact/list?userId=USER_GUID&contactId=-2719115600493040594&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "description": "string",
- "isCompleted": true,
- "taskId": 0,
- "dateCreated": "2025-06-14T19:54:00Z",
- "dateDue": "2025-06-14T19:54:00Z"
}

]

Create a task for a domain

get /tasks/domain/create

https://www.spyfu.com:80/apis/my_spyfu_api/tasks/domain/create

query Parameters

userId required	string <uuid> User's ID
domainId required	integer <int64> Domain ID
dateDue required	string <date-time> Date task is due
description required	string Task description
isCompleted	boolean Task completion status
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/tasks/domain/create?userId=USER_GUID&domainId=DOMAIN_GUID&dateDue=12/31/2020&description=Review by end of business day.&isCompleted=false&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"description": "string",
"isCompleted": true,
"taskId": 0,
"dateCreated": "2025-06-14T19:54:00Z",
"dateDue": "2025-06-14T19:54:00Z"

}

Create a task for a url

get /tasks/url/create

https://www.spyfu.com:80/apis/my_spyfu_api/tasks/url/create

query Parameters

userId required	string <uuid> User's ID
domainId required	integer <int64> Domain ID
urlId required	integer <int64> URL ID
dateDue required	string <date-time> Date task is due
description required	string Task description
isCompleted	boolean Task completion status
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/tasks/url/create?userId=USER_GUID&domainId=DOMAIN_GUID&urlId=8184723504097168719&dateDue=12/31/2020&description=Review by end of business day.&isCompleted=false&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"description": "string",
"isCompleted": true,
"taskId": 0,
"dateCreated": "2025-06-14T19:54:00Z",
"dateDue": "2025-06-14T19:54:00Z"

}

Create a task for a contact

get /tasks/contact/create

https://www.spyfu.com:80/apis/my_spyfu_api/tasks/contact/create

query Parameters

userId required	string <uuid> User's ID
contactId required	integer <int64> Contact ID
dateDue required	string <date-time> Date task is due
description required	string Task description
isCompleted	boolean Task completion status
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/tasks/contact/create?userId=USER_GUID&contactId=-2719115600493040594&dateDue=12/31/2020&description=Review by end of business day.&isCompleted=false&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"description": "string",
"isCompleted": true,
"taskId": 0,
"dateCreated": "2025-06-14T19:54:00Z",
"dateDue": "2025-06-14T19:54:00Z"

}

Edit a task

get /tasks/update

https://www.spyfu.com:80/apis/my_spyfu_api/tasks/update

query Parameters

userId required	string <uuid> User's ID
dateDue required	string Date task is due
taskRowId required	integer <int64> Task ID
description required	string Task description
isCompleted required	boolean Task completion status
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/tasks/update?userId=USER_GUID&taskRowId=1&dateDue=12/31/2020&description=Review by end of business day.&isCompleted=true&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"description": "string",
"isCompleted": true,
"taskId": 0,
"dateCreated": "2025-06-14T19:54:00Z",
"dateDue": "2025-06-14T19:54:00Z"

}

Delete a task

get /tasks/delete

https://www.spyfu.com:80/apis/my_spyfu_api/tasks/delete

query Parameters

userId required	string <uuid> User's ID
taskRowId required	integer <int64> Task ID
api_key	string User's secret key

Responses

204

NoContent

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/tasks/delete?userId=USER_GUID&taskRowId=1&api_key=SECRET_KEY"

HistoryApi

Read activity history for outreach targets.

Get activity history for a domain

get /history/domain/list

https://www.spyfu.com:80/apis/my_spyfu_api/history/domain/list

query Parameters

userId required	string <uuid> User's ID
domainId required	integer <int64> Domain ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/history/domain/list?userId=USER_GUID&domainId=DOMAIN_GUID&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "eventTime": "2025-06-14T19:54:00Z",
- "eventType": "string",
- "description": "string"
}

]

Get activity history for a url

get /history/url/list

https://www.spyfu.com:80/apis/my_spyfu_api/history/url/list

query Parameters

userId required	string <uuid> User's ID
domainId required	integer <int64> Domain ID
urlId required	integer <int64> URL ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/history/url/list?userId=USER_GUID&domainId=DOMAIN_GUID&urlId=8184723504097168719&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "eventTime": "2025-06-14T19:54:00Z",
- "eventType": "string",
- "description": "string"
}

]

Get activity history for a contact

get /history/contact/list

https://www.spyfu.com:80/apis/my_spyfu_api/history/contact/list

query Parameters

userId required	string <uuid> User's ID
contactId required	integer <int64> Contact ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/history/contact/list?userId=USER_GUID&contactId=-2719115600493040594&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "eventTime": "2025-06-14T19:54:00Z",
- "eventType": "string",
- "description": "string"
}

]

ContactEventsApi

Track outreach events with contacts.

Gets a list of contact events for a domain

get /contactevents/domain/get

https://www.spyfu.com:80/apis/my_spyfu_api/contactevents/domain/get

query Parameters

userId required	string <uuid> User's ID
domainId required	integer <int64> Domain ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/contactevents/domain/get?userId=USER_GUID&domainId=DOMAIN_GUID&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "eventType": "string",
- "note": "string",
- "eventId": 0,
- "eventTypeId": 0,
- "dateCreated": "2025-06-14T19:54:00Z"
}

]

Gets a list of contact events for a URL

get /contactevents/url/get

https://www.spyfu.com:80/apis/my_spyfu_api/contactevents/url/get

query Parameters

userId required	string <uuid> User's ID
domainId required	integer <int64> Domain ID
urlId required	integer <int64> URL ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/contactevents/url/get?userId=USER_GUID&domainId=DOMAIN_GUID&urlId=8184723504097168719&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "eventType": "string",
- "note": "string",
- "eventId": 0,
- "eventTypeId": 0,
- "dateCreated": "2025-06-14T19:54:00Z"
}

]

Gets a list of contact event for a contact

get /contactevents/contact/get

https://www.spyfu.com:80/apis/my_spyfu_api/contactevents/contact/get

query Parameters

userId required	string <uuid> User's ID
contactId required	integer <int64> Contact ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/contactevents/contact/get?userId=USER_GUID&contactId=-2719115600493040594&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "eventType": "string",
- "note": "string",
- "eventId": 0,
- "eventTypeId": 0,
- "dateCreated": "2025-06-14T19:54:00Z"
}

]

Create a contact event for a domain

get /contactevents/domain/create

https://www.spyfu.com:80/apis/my_spyfu_api/contactevents/domain/create

query Parameters

userId required	string <uuid> User's ID
note required	string Note text
eventTypeId required	integer <int32> Enum: 1 2 3 4 Type of event: (Email = 1, SocialMedia = 2, Phone = 3, Other = 4)
domainId required	integer <int64> Domain ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/contactevents/domain/create?userId=USER_GUID&note=Review by end of business day.&eventTypeId=4&domainId=DOMAIN_GUID&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"eventType": "string",
"note": "string",
"eventId": 0,
"eventTypeId": 0,
"dateCreated": "2025-06-14T19:54:00Z"

}

Create a contact event for a URL

get /contactevents/url/create

https://www.spyfu.com:80/apis/my_spyfu_api/contactevents/url/create

query Parameters

userId required	string <uuid> User's ID
note required	string Note text
eventTypeId required	integer <int32> Enum: 1 2 3 4 Type of event: (Email = 1, SocialMedia = 2, Phone = 3, Other = 4)
domainId required	integer <int64> Domain ID
urlId required	integer <int64> URL ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/contactevents/url/create?userId=USER_GUID&note=Review by end of business day.&eventTypeId=4&domainId=DOMAIN_GUID&urlId=8184723504097168719&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"eventType": "string",
"note": "string",
"eventId": 0,
"eventTypeId": 0,
"dateCreated": "2025-06-14T19:54:00Z"

}

Create a contact event for a contact

get /contactevents/contact/create

https://www.spyfu.com:80/apis/my_spyfu_api/contactevents/contact/create

query Parameters

userId required	string <uuid> User's ID
note required	string Note text
eventTypeId required	integer <int32> Enum: 1 2 3 4 Type of event: (Email = 1, SocialMedia = 2, Phone = 3, Other = 4)
contactId required	integer <int64> Contact ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/contactevents/contact/create?userId=USER_GUID&note=Review by end of business day.&eventTypeId=4&domainId=DOMAIN_GUID&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"eventType": "string",
"note": "string",
"eventId": 0,
"eventTypeId": 0,
"dateCreated": "2025-06-14T19:54:00Z"

}

Delete a contact event

get /contactevents/delete

https://www.spyfu.com:80/apis/my_spyfu_api/contactevents/delete

query Parameters

userId required	string <uuid> User's ID
rowId required	integer <int64> Event row ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/contactevents/delete?userId=USER_GUID&rowId=1&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"success": true,
"message": "string"

}

UserHistoryApi

User's search history.

Returns list of recent searches by user

get /userhistory/get

https://www.spyfu.com:80/apis/my_spyfu_api/userhistory/get

query Parameters

userId required	string User's ID
count required	integer <int32> Maximum number of rows
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/my_spyfu_api/userhistory/get?userId=USER_GUID&count=100&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "itemId": "string",
- "date": "2025-06-14T19:54:00Z",
- "url": "string",
- "item": "string",
- "itemType": "string"
}

]

Project Management and Keyword Tracking API Documentation (v1)

Authentication

Authentication

api_key

ProjectsApi

Returns list of projects belonging to user

query Parameters

Responses

Request samples

Response samples

Create a new project

query Parameters

Responses

Request samples

Response samples

Deletes an existing project

query Parameters

Responses

Request samples

Updates an existing project

query Parameters

Responses

Request samples

Move a domain and all linked data from one project to another

query Parameters

Responses

Request samples

Find projects that include these urls

query Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Find projects that include these terms

query Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

KeywordsApi

Get list of keywords for a project

query Parameters

Responses

Request samples

Response samples

Add new keywords to a project

query Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Remove keywords from a project

query Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Undo a recent keyword deletion

query Parameters

Request Body schema: application/json

Responses

Request samples

Move keywords from one project to another

query Parameters

Request Body schema: application/json

Responses

Request samples

Export project keywords as a CSV

query Parameters

Responses

Request samples

Response samples

Bulk import keywords with associated groups and/or labels

query Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Bulk import keywords with associated groups and/or labels

query Parameters

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json