collaborators

Site List using Email Address

Get a list of all sites that are attached to a Collaborator using the collaborator's email address. All sites information returned are from the collaborator's perspective. If the site is favorited by the collaborator favorite will be set to true, if the collaborator has added tags to sites then their site tags will be in the response.

get/collaborators/{email_address}/sites

Request

Path parameters

email_addressstring required

Query parameters

tag_namestring
per_pageinteger
pageinteger

Response

Successful Response

messagestring
dataobject
pageobject

Example response

{
  "message": "Success",
  "data": {
    "name": "Claire Doe",
    "email": "clairedoe@example.com",
    "sites": [
      {
        "id": 1,
        "created": "2022-01-31T20:05:30.000Z",
        "accountId": 2,
        "clonedFromId": null,
        "collaboratorsCount": 3,
        "displayName": "pressable.com",
        "domainsCount": 1,
        "ecommerce": false,
        "favorite": false,
        "ipAddresses": [
          "199.16.172.38",
          "199.16.173.236"
        ],
        "name": "my-presssable-net",
        "state": "live",
        "url": "pressable.com",
        "staging": false,
        "sandbox": false,
        "sftpDomain": "sftp.pressable.com",
        "phpVersion": "8.2",
        "tags": []
      },
      {
        "id": 4,
        "created": "2022-01-31T20:05:30.000Z",
        "accountId": 2,
        "clonedFromId": null,
        "collaboratorsCount": 1,
        "displayName": "four",
        "domainsCount": 0,
        "ecommerce": false,
        "favorite": false,
        "ipAddresses": [
          "199.16.172.123",
          "199.16.173.175"
        ],
        "name": "four",
        "state": "live",
        "url": "four.mystagingwebsite.com",
        "staging": true,
        "sandbox": false,
        "sftpDomain": "sftp.pressable.com",
        "phpVersion": "8.2",
        "tags": []
      }
    ]
  },
  "page": {
    "currentPage": 1,
    "nextPage": 2,
    "lastPage": 65,
    "perPage": 20,
    "totalItems": 1297
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.