v4

latestSwagger 2.02026-08-0343714211.7 MB

partner_site_requests

Partner Site Requests

List Partner Site Requests

get/partner_site_requests

Query parameters

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

If set, sort records by the specified field in either asc or desc direction. Valid fields are host_partner_id.

If set, return records where the specified field is equal to the supplied value. Valid fields are host_partner_id.

Response

A list of PartnerSiteRequests objects.

idinteger

Partner Site Request ID

host_partner_idinteger

Host Partner ID

guest_site_urlstring

Guest Site URL

status'pending' | 'approved' | 'rejected'

Request status (pending, approved, rejected)

host_site_namestring

Host Site Name

pairing_keystring

Pairing key used to approve this request on the Guest Site

created_atstring date-time

Request creation date/time

updated_atstring date-time

Request last updated date/time

Example response

[
  {
    "id": 1,
    "host_partner_id": 1,
    "guest_site_url": "https://example.files.com",
    "status": "pending",
    "host_site_name": "Acme Site",
    "pairing_key": "abc123xyz",
    "created_at": "2000-01-01T01:00:00Z",
    "updated_at": "2000-01-01T01:00:00Z"
  }
]