Get your agency page
Your agency's page in Corefinity's partner directory and the change request that is waiting for approval, each null when there is none. Your role needs the viewAgencyPage permission.
GET/ api/ agency/ page
Returns
200 The page and its open change request.
Fields of the 200 answer
dataobjectRequired
Fields
change_requestobject or any or nullRequired
The request that is waiting for approval.
pageobject or any or nullRequired
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | Send a valid token as Authorization: Bearer <token>. |
403 | forbidden | The person is not allowed to do this. |
403 | scope_required | Use a token with the scope named in scope. |
429 | rate_limited | Wait for the seconds in Retry-After. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
curl https://manage.corefinity.com/api/agency/page \
-H "Authorization: Bearer $COREFINITY_TOKEN" \
-H "Accept: application/json"use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->get('https://manage.corefinity.com/api/agency/page');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/agency/page', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
},
});
// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);import os
import requests
res = requests.get(
"https://manage.corefinity.com/api/agency/page",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"data": {
"change_request": null,
"page": {
"address": "14 Harbour Row, Bristol",
"content": "We build and run online shops.",
"email_address": "[email protected]",
"id": 3207,
"listing_description": "Magento and Shopware builds for UK retailers.",
"name": "Northwind Digital",
"phone_number": "01632 960 123",
"published": true,
"services": [
"Magento",
"Hosting"
],
"slug": "northwind-digital",
"status": "live",
"subheading": "Magento specialists",
"website_url": "https://northwind-digital.example.com"
}
}
}{
"message": "Unauthenticated."
}{
"code": "forbidden",
"message": "You are not allowed to view your agency page.",
"reason": "forbidden",
"status": "error"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}Try it
Was this helpful?