Skip to content

docs: add GET /v1/activity endpoint documentation #635

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
firecrawl-spring wants to merge 6 commits into
base: main
Choose a base branch
from
Open

docs: add GET /v1/activity endpoint documentation #635

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0811236
docs: add GET /v1/activity endpoint documentation
firecrawl-spring[bot] Mar 16, 2026
7180538
fix: address activity endpoint review feedback
firecrawl-spring[bot] Mar 16, 2026
722d508
docs: update activity endpoint - remove origin/integration, add brows…
firecrawl-spring[bot] Mar 17, 2026
5366fb4
refactor(activity): rename kind→endpoint, fix cursor mismatch
firecrawl-spring[bot] Mar 18, 2026
3260ab9
fix(docs): trim activity endpoint list and fix v2 retrieval paths
firecrawl-spring[bot] Mar 23, 2026
2d2fdff
revert: restore full endpoint enum lists in OpenAPI specs
firecrawl-spring[bot] Mar 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions api-reference/endpoint/activity.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: 'Activity'
openapi: '/api-reference/v2-openapi.json GET /activity'
---

Lists your recent API activity from the last 24 hours. Use this to discover job IDs, then retrieve results with the corresponding GET endpoint.

| Endpoint | Retrieval Endpoint |
|---|---|
| `scrape` | `GET /v2/scrape/{id}` |
| `crawl` | `GET /v2/crawl/{id}` |
| `batch_scrape` | `GET /v2/batch/scrape/{id}` |
| `agent` | `GET /v2/extract/{id}` |
13 changes: 13 additions & 0 deletions api-reference/v1-endpoint/activity.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: 'Activity'
openapi: '/api-reference/v1-openapi.json GET /activity'
---

Lists your recent API activity from the last 24 hours. Use this to discover job IDs, then retrieve results with the corresponding GET endpoint.

| Endpoint | Retrieval Endpoint |
|---|---|
| `scrape` | `GET /v1/scrape/{id}` |
| `crawl` | `GET /v1/crawl/{id}` |
| `batch_scrape` | `GET /v1/batch/scrape/{id}` |
| `agent` | `GET /v1/extract/{id}` |
105 changes: 105 additions & 0 deletions api-reference/v1-openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2067,6 +2067,111 @@
}
}
},
"/activity": {
"get": {
"summary": "List recent API activity",
"operationId": "getActivity",
"description": "Lists your team's recent API activity from the last 24 hours. Returns metadata about each job including the job ID, which can be used with the corresponding GET endpoint (e.g. GET /v1/crawl/{id}) to retrieve full results. Supports cursor-based pagination and filtering by endpoint.",
"tags": ["Account"],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "endpoint",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": ["scrape", "crawl", "batch_scrape", "search", "extract", "llmstxt", "deep_research", "map", "agent", "browser"]
},
"description": "Filter by endpoint"
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"minimum": 1,
"maximum": 100
},
"description": "Maximum number of results per page"
},
{
"name": "cursor",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"description": "Cursor for pagination. Use the cursor value from the previous response."
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": true
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The job ID. Use this with the corresponding GET endpoint to retrieve results."
},
"endpoint": {
"type": "string",
"enum": ["scrape", "crawl", "batch_scrape", "search", "extract", "llmstxt", "deep_research", "map", "agent", "browser"],
"description": "The endpoint used for this job"
},
"api_version": {
"type": "string",
"description": "The API version used for this request",
"example": "v1"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "When the job was created"
},
"target": {
"type": "string",
"nullable": true,
"description": "The URL or query that was submitted"
}
}
}
},
"cursor": {
"type": "string",
"nullable": true,
"description": "Cursor to use for the next page. Null if there are no more results."
},
"has_more": {
"type": "boolean",
"description": "Whether there are more results available"
}
}
}
}
}
}
}
}
},
"/search": {
"post": {
"summary": "Search and optionally scrape search results",
Expand Down
105 changes: 105 additions & 0 deletions api-reference/v2-openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2187,6 +2187,111 @@
}
}
},
"/activity": {
"get": {
"summary": "List recent API activity",
"operationId": "getActivity",
"description": "Lists your team's recent API activity from the last 24 hours. Returns metadata about each job including the job ID, which can be used with the corresponding GET endpoint (e.g. GET /crawl/{id}) to retrieve full results. Supports cursor-based pagination and filtering by endpoint.",
"tags": ["Account"],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "endpoint",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": ["scrape", "crawl", "batch_scrape", "search", "extract", "llmstxt", "deep_research", "map", "agent", "browser"]
},
"description": "Filter by endpoint"
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"minimum": 1,
"maximum": 100
},
"description": "Maximum number of results per page"
},
{
"name": "cursor",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"description": "Cursor for pagination. Use the cursor value from the previous response."
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": true
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The job ID. Use this with the corresponding GET endpoint to retrieve results."
},
"endpoint": {
"type": "string",
"enum": ["scrape", "crawl", "batch_scrape", "search", "extract", "llmstxt", "deep_research", "map", "agent", "browser"],
"description": "The endpoint used for this job"
},
"api_version": {
"type": "string",
"description": "The API version used for this request",
"example": "v1"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "When the job was created"
},
"target": {
"type": "string",
"nullable": true,
"description": "The URL or query that was submitted"
}
}
}
},
"cursor": {
"type": "string",
"nullable": true,
"description": "Cursor to use for the next page. Null if there are no more results."
},
"has_more": {
"type": "boolean",
"description": "Whether there are more results available"
}
}
}
}
}
}
}
}
},
"/search": {
"post": {
"summary": "Search and optionally scrape search results",
Expand Down
2 changes: 2 additions & 0 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,7 @@
{
"group": "Account Endpoints",
"pages": [
"api-reference/endpoint/activity",
"api-reference/endpoint/credit-usage",
"api-reference/endpoint/credit-usage-historical",
"api-reference/endpoint/token-usage",
Expand Down Expand Up @@ -493,6 +494,7 @@
{
"group": "Account Endpoints",
"pages": [
"api-reference/v1-endpoint/activity",
"api-reference/v1-endpoint/credit-usage",
"api-reference/v1-endpoint/credit-usage-historical",
"api-reference/v1-endpoint/token-usage",
Expand Down