Skip to main content
GET
/
v1
/
api
/
get_domain_paginated
curl -X GET "https://api.hookpulse.io/v1/api/get_domain_paginated/?page={{page}}" \
  -H "x-hookpulse-api-key: {{x-hookpulse-api-key}}" \
  -H "x-brand-uuid: {{x-brand-uuid}}" \
  -H "Content-Type: application/json"

{
  "data": [
    {
      "protocol_type": "{{protocol_type}}",
      "rate_limit_enabled": {{rate_limit_enabled}},
      "concurrency_control_enabled": {{concurrency_control_enabled}},
      "max_concurrent_jobs": {{max_concurrent_jobs}},
      "max_requests_per_second": {{max_requests_per_second}},
      "domain_uuid": "{{domain_uuid}}",
      "domain_name": "{{domain_name}}"
    }
  ],
  "meta": {
    "page": {{page}},
    "total_count": {{total_count}},
    "per_page": {{per_page}},
    "total_pages": {{total_pages}},
    "has_next": {{has_next}},
    "has_prev": {{has_prev}}
  },
  "success": true,
  "timezone": "{{timezone}}"
}
Retrieve a paginated list of domains from your HookPulse account.

​
Example request

curl -X GET "https://api.hookpulse.io/v1/api/get_domain_paginated/?page={{page}}" \
  -H "x-hookpulse-api-key: {{x-hookpulse-api-key}}" \
  -H "x-brand-uuid: {{x-brand-uuid}}" \
  -H "Content-Type: application/json"

​
Query parameters

ParameterTypeRequiredDescription
pageintegerYesPage number to retrieve (starts from 1)

​
Example response

{
  "data": [
    {
      "protocol_type": "{{protocol_type}}",
      "rate_limit_enabled": {{rate_limit_enabled}},
      "concurrency_control_enabled": {{concurrency_control_enabled}},
      "max_concurrent_jobs": {{max_concurrent_jobs}},
      "max_requests_per_second": {{max_requests_per_second}},
      "domain_uuid": "{{domain_uuid}}",
      "domain_name": "{{domain_name}}"
    }
  ],
  "meta": {
    "page": {{page}},
    "total_count": {{total_count}},
    "per_page": {{per_page}},
    "total_pages": {{total_pages}},
    "has_next": {{has_next}},
    "has_prev": {{has_prev}}
  },
  "success": true,
  "timezone": "{{timezone}}"
}

​
Response fields

​
Data array

FieldTypeDescription
protocol_typestringProtocol type for the domain
rate_limit_enabledbooleanWhether rate limiting is enabled
concurrency_control_enabledbooleanWhether concurrency control is enabled
max_concurrent_jobsintegerMaximum concurrent jobs allowed
max_requests_per_secondintegerMaximum requests per second allowed
domain_uuidstringUnique identifier for the domain
domain_namestringDomain name

​
Meta object

FieldTypeDescription
pageintegerCurrent page number
total_countintegerTotal number of domains
per_pageintegerNumber of items per page
total_pagesintegerTotal number of pages
has_nextbooleanWhether there is a next page
has_prevbooleanWhether there is a previous page

​
Root fields

FieldTypeDescription
successbooleanIndicates if the request was successful
dataarrayArray of domain objects
metaobjectPagination metadata
timezonestringIANA timezone identifier indicating the timezone used for all timestamps in the response (matches your brand’s selected timezone)

​
Error Responses

If the page is out of range, you will receive: 
{
  "success": false,
  "timezone": "{{timezone}}",
  "error": "Page out of range",
  "meta": {
    "page": {{page}},
    "total_count": {{total_count}},
    "per_page": {{per_page}},
    "total_pages": {{total_pages}},
    "has_next": {{has_next}},
    "has_prev": {{has_prev}}
  }
}

Authorizations

​
x-hookpulse-api-key
string
header
required

API key for authentication. Get this from your dashboard by selecting a brand and going to API Keys section.

​
x-brand-uuid
string
header
required

Brand UUID for authentication. Get this from your dashboard after adding a brand - it will be displayed in the UI.

Query Parameters

​
page
integer<int32>
required

Page number to retrieve (starts from 1)

Required range: x >= 1

Response

Successful response

​
data
object[]
​
meta
object
​
success
boolean

Indicates if the request was successful

​
timezone
string

IANA timezone identifier indicating the timezone used for all timestamps in the response (matches your brand's selected timezone)