Retrieves all Brand Boards for a specific account
GET https://services.leadconnectorhq.com/brand-boards/{locationId}
Autorización
Bearer token generado desde el portal Leadway. Ver Autenticación. Version
string
default:"2021-07-28"
required
Versión de la API.
Path parameters
Query parameters
Maximum number of brand boards to return
Number of brand boards to skip for pagination
search
string
default:"brandboard"
Search term to filter brand boards by name
Include deleted brand boards in results
Respuestas
Array of brand boards for the account
_id
string
default:"507f1f77bcf86cd799439011"
required
Brand board ID
name
string
default:"My Brand Board"
required
Brand board name
updatedAt
string
default:"2024-01-05T12:00:00.000Z"
required
Last update timestamp
Whether this is the default brand board for the account
Metadata about the brand board
totalCount
number
default:"42"
required
Total number of brand boards matching the query
{
"brandBoards": [
{
"_id": "507f1f77bcf86cd799439011",
"name": "My Brand Board",
"updatedAt": "2024-01-05T12:00:00.000Z",
"default": false
}
],
"totalCount": 42
}
403 - The token does not have access to this account
message
string
default:"The token does not have access to this account"
{
"statusCode": 403,
"message": "The token does not have access to this account"
}
422 - Unprocessable Entity
Ejemplo
curl -X GET 'https://services.leadconnectorhq.com/brand-boards/YOUR_locationId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
const response = await fetch('https://services.leadconnectorhq.com/brand-boards/YOUR_locationId', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/brand-boards/YOUR_locationId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
<?php
$ch = curl_init('https://services.leadconnectorhq.com/brand-boards/YOUR_locationId');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
