Get all email seats

GET

https://ext.gojiberry.ai

email-seat

Get all email seats

curl --request GET \
  --url https://ext.gojiberry.ai/v1/email-seat \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://ext.gojiberry.ai/v1/email-seat', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ext.gojiberry.ai/v1/email-seat",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://ext.gojiberry.ai/v1/email-seat"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://ext.gojiberry.ai/v1/email-seat")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "id": 123,
    "email": "<string>",
    "name": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "type": "google",
    "purchased": true,
    "dailyEmailMax": 123,
    "dailyEmailCount": 123,
    "launchHour": 123,
    "activeDays": {
      "monday": true,
      "tuesday": true,
      "wednesday": true,
      "thursday": true,
      "friday": true,
      "saturday": true,
      "sunday": true
    },
    "trackOpening": true,
    "removeUnsubscribeLink": true,
    "warmupEnabled": true,
    "warmupCompleted": true,
    "warmupStartedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
]

Authorizations

Authorization

string

header

required

API key from Settings → API. Send it as Authorization: Bearer .

Headers

x-impersonate-user-id

string

ID of an organization member to act on behalf of. The API key user must be the owner of the organization and the target user must belong to the same organization.

Response

200 - application/json

List of email seats

number

Email seat ID (usable in the emailSeatIds field of POST /v1/campaign)

string

Email address of the mailbox

name

string | null

Display name used as sender name

firstName

string | null

First name of the sender

lastName

string | null

Last name of the sender

type

enum<string>

Email provider of the mailbox

Available options:

google,

outlook

purchased

boolean

Whether the mailbox was purchased through Gojiberry

dailyEmailMax

number

Maximum number of emails sent per day

dailyEmailCount

number

Number of emails sent today

launchHour

number

Hour of the day (0-23) at which the daily sending starts

activeDays

object | null

Days of the week on which the seat sends emails

Show child attributes

trackOpening

boolean

Whether email opens are tracked

removeUnsubscribeLink

boolean

Whether the unsubscribe link is removed from the emails

warmupEnabled

boolean

Whether the mailbox warm-up is enabled

warmupCompleted

boolean

Whether the mailbox warm-up is completed

warmupStartedAt

string<date-time> | null

Date at which the warm-up started

createdAt

string<date-time>

Date at which the mailbox was connected

updatedAt

string<date-time>

Last update date

⌘I

Get all email seats

curl --request GET \
  --url https://ext.gojiberry.ai/v1/email-seat \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://ext.gojiberry.ai/v1/email-seat', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ext.gojiberry.ai/v1/email-seat",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://ext.gojiberry.ai/v1/email-seat"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://ext.gojiberry.ai/v1/email-seat")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "id": 123,
    "email": "<string>",
    "name": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "type": "google",
    "purchased": true,
    "dailyEmailMax": 123,
    "dailyEmailCount": 123,
    "launchHour": 123,
    "activeDays": {
      "monday": true,
      "tuesday": true,
      "wednesday": true,
      "thursday": true,
      "friday": true,
      "saturday": true,
      "sunday": true
    },
    "trackOpening": true,
    "removeUnsubscribeLink": true,
    "warmupEnabled": true,
    "warmupCompleted": true,
    "warmupStartedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
]

Getting Started

API reference

Authorizations

Headers

Response