OpenAPI reference · Settings
List the workspace's LinkedIn company pages
/company-pagesEvery company page discovered or activated in the active
workspace — the delta over GET /projects: activation status,
STORED admin token health (as of last validation), follower
count, and the activated project's engagement-policy state.
Requires the projects:read scope.
Authorization
AuthorizationstringrequiredBearer token in the Authorization header.
Pass
Authorization: Bearer scripe_sk_live_<...>(orscripe_sk_test_<...>for test keys) on every request. Keys are scoped to a single workspace and can be revoked from the Scripe dashboard.The same header also accepts an OAuth 2.1 access token (
scripe_oat_*); both credentials share one scope vocabulary and every operation below documents the scope it requires. An API key can hold every scope named on this surface exceptwebhooks:manage, which is grantable to OAuth tokens only today — the webhook-endpoint operations answer403 scope_missingto every API key. Operations that name no scope accept any valid token of the workspace.
Header parameters
Scripe-Api-VersionstringPin the API version. Format
YYYY-MM-DD. Omit to receive the currently rolling default. Unknown versions return400 version_unsupported.
Responses
- 200
The workspace's company pages.
- 401
Missing, malformed, expired, or revoked API key.
- 403
Plan not eligible, scope missing, or workspace mismatch.
- 429
Sliding-window rate limit exceeded.
Example request
curl --request GET \
--url 'https://api.scripe.io/v1/company-pages' \
--header 'Authorization: Bearer <token>'Example response (200)
{
"data": [
{
"id": "cpg_a1b2c3d4e5f6g7h8",
"name": "string",
"vanityName": "string",
"logoUrl": "string",
"status": "discovered",
"activatedProject": {
"id": "string",
"name": "string"
},
"activatedAt": "string",
"followerCount": 0,
"adminTokenHealth": [
{
"projectId": "string",
"tokenStatus": "valid",
"lastVerifiedAt": "string",
"failureReason": "string"
}
],
"engagementPolicy": {
"likeDefault": "OFF",
"commentDefault": "OFF",
"reshareDefault": "OFF"
},
"createdAt": "string"
}
]
}