Get Inbound Site

This operation is used to retrived the Inbound Sites.

SecuritybearerAuth
Request
query Parameters
skip
integer

Number of records to skip from the beginning.

Example: skip=0
limit
integer

Maximum number of records to return in one response.

Example: limit=20
sort
string

Sorts the results by a specific field in ascending (ASC) or descending (DESC) order.

Example: sort=name,ASC
query
string

Searches for inbound sites using a keyword.

Example: query=site
searchBy
string

Finds inbound sites based on a relationship with another site.

Examples:
searchBy=parent:X7okeWJyx5zz
searchBy=ancestorlist:X7okeWJyx5zz
fetchPrimarySite
boolean

Only get default site in response, if set true.

Example: fetchPrimarySite=true
timestamp
string

Get inbound site which are created before or after the provided timestamp.

Example: timestamp=2024-11-19T07:54:46.807
status
string

Only get default site in response, if set true.

Enum: "active" "inactive"
Example: status=active
Responses
200

Requested Inbound Sites list has been retrived successfully.

400

Invalid request.

401

The request could not be authorized.

500

The request could not be completed due to an internal error.

get/api/v1/inboundsites
Request samples 
Response samples 
application/json
{
  • "inboundsites": [
    ],
  • "pageInfo": {
    }
}