Skip to content
Prefactor Docs

List domains

GET
/api/v1/domain

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
account_id
required
sorting
pagination[offset]
pagination[page_size]

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success

object
pagination
One of:
PaginationOutput

Pagination information

object
item_count

The total number of items

number
item_end

The index of the last item in the page (one-based)

number
item_start

The index of the first item in the page (one-based)

number
next_page_offset
One of:

The offset of the next page (null if last page)

number
page_count

The total number of pages

number
page_index

The index of the current page (one-based)

number
page_offset

The offset of the first item in the page (zero-based)

number
page_size

The number of items per page

number
previous_page_offset
One of:

The offset of the previous page (null if first page)

number
 
{
  "item_count": 200,
  "item_end": 100,
  "item_start": 91,
  "next_page_offset": 110,
  "page_count": 20,
  "page_index": 10,
  "page_offset": 90,
  "page_size": 10,
  "previous_page_offset": 80
}
sorting
One of:
Sorting

Sorting information

object
direction

The direction to sort by

string
Allowed values: asc desc 
asc
field

The field to sort by (values depend on the type of list)

string
Allowed values: id last_seen status title 
id
status
string
Allowed values: success 
success
summaries
Array<object>
Domain_Summary
object
account_id
Account_Id

A valid account ID

string
013xrzp12g3nqk8n6cyr5x0k8yb10h59
id
Domain_Id

A valid domain ID

string
013xrzp12g3nqk8n32sd3jyxq5a8ywe2
status
string
Allowed values: extant deleted 
extant
title
string
type
string
Allowed values: domain 
domain

default

Section titled “default ”

Error

One of:
object
code
string
Allowed values: bad_request bad_authtoken not_authenticated not_permitted not_implemented unknown not_found unexpected_ref_type unexpected invalid_action invalid_value required_value 
bad_request
message
string
status
string
Allowed values: error 
error