Skip to content

Pages

Pages are our way of representing organisations. Often they are companies, but they don't have to be. Examples of other organisation types are charities, educational institutions and government bodies.

They are also used for email targeting, and in some cases, for feed targeting. These targeting criteria may change at our discretion, based on our analytics and research.

This API does not allow creating them, as their visual representation may require curation. If a page does not yet exist, we recommend that you create them on platform in order to accurately review the logo and header image presentation.

Attributes

id

int readonly

Internal ID, used to retrieve this record and as identifier in relationships from other records.

title

string readonly

Name of the organisation.

string readonly

URL to the organisation's logo as uploaded to our platform.

Endpoints

Accepts the following parameters in the body:

query

string required

Search query to use

page

int optional

Default: 1

Page number of results to fetch.

perPage

int optional

Default: 24

Number of results to fetch per page. Maximum is 100.

HTTP
POST /channels/pages.search
Content-Type: application/json
Authorization: Channel <Api Key>
X-Channel: <Channel Identifier>

{
    "query": "your search term"
}
JSON
{
    "requestId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "status": 200,
    "data": {
        "id": 1,
        "title": "The Dots",
        "logo": "https://images1.the-dots.com/3247931/dots-logo.jpeg?p=squareContained"
    }
}

Get

HTTP
GET /channels/pages/{id}
Content-Type: application/json
Authorization: Channel <Api Key>
X-Channel: <Channel Identifier>
JSON
{
    "requestId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "status": 200,
    "data": {
        "id": 1,
        "title": "The Dots",
        "logo": "https://images1.the-dots.com/3247931/dots-logo.jpeg?p=squareContained"
    }
}