Contacts API

get listing

GET /api/rest/admin/contacts

Parameters

Name	Description
filter[id]	id filter
filter[email-eq]	email eq filter
filter[email-not-eq]	email not eq filter
filter[email-cont]	email cont filter
filter[email-start]	email start filter
filter[email-end]	email end filter
filter[email-in]	email in filter
filter[email-not-in]	email not in filter
filter[email-cont-any]	email cont any filter
filter[notes-eq]	notes eq filter
filter[notes-not-eq]	notes not eq filter
filter[notes-cont]	notes cont filter
filter[notes-start]	notes start filter
filter[notes-end]	notes end filter
filter[notes-in]	notes in filter
filter[notes-not-in]	notes not in filter
filter[notes-cont-any]	notes cont any filter

Request

Headers

Version: HTTP/1.0
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjU0LCJhdWQiOlsiYWRtaW4iXSwiZXhwIjoxNzQwODUzMDI2fQ.nJGZTkt8czNjhkTpERIkOGhWTClL17mcOG2PNb2qTig
Host: example.org
Cookie: 

Route

GET /api/rest/admin/contacts

Response

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 0
X-Content-Type-Options: nosniff
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/vnd.api+json
Vary: Accept
ETag: W/"14a7615ee665f9ea52ce4304acffa443"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 04dc3103-5391-4d24-8d26-1c8d756bbf2a
X-Runtime: 0.013864
Content-Length: 1004

Status

200 OK

Body

{
  "data": [
    {
      "id": "44",
      "type": "contacts",
      "links": {
        "self": "http://example.org/api/rest/admin/contacts/44"
      },
      "attributes": {
        "email": "rspec_mail_1@example.com",
        "notes": null
      },
      "relationships": {
        "contractor": {
          "links": {
            "self": "http://example.org/api/rest/admin/contacts/44/relationships/contractor",
            "related": "http://example.org/api/rest/admin/contacts/44/contractor"
          },
          "data": {
            "type": "contractors",
            "id": "23"
          }
        }
      }
    },
    {
      "id": "45",
      "type": "contacts",
      "links": {
        "self": "http://example.org/api/rest/admin/contacts/45"
      },
      "attributes": {
        "email": "rspec_mail_2@example.com",
        "notes": null
      },
      "relationships": {
        "contractor": {
          "links": {
            "self": "http://example.org/api/rest/admin/contacts/45/relationships/contractor",
            "related": "http://example.org/api/rest/admin/contacts/45/contractor"
          },
          "data": {
            "type": "contractors",
            "id": "24"
          }
        }
      }
    }
  ],
  "meta": {
    "total-count": 2
  },
  "links": {
    "first": "http://example.org/api/rest/admin/contacts?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "http://example.org/api/rest/admin/contacts?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}