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

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjU5LCJhdWQiOlsiYWRtaW4iXSwiZXhwIjoxNzcyMjEyMDAxfQ.ziBMzik7amuHn6KGWqLHWHReIf6LvPseU_IucUg_nL4
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/"4bc3c54c6d87ade4943cbabf43c77ae7"
cache-control: max-age=0, private, must-revalidate
x-request-id: f301c874-c255-4911-ae8f-4bbd739d60fd
x-runtime: 0.007159
content-length: 1004

Status

200 OK

Body

{
  "data": [
    {
      "id": "49",
      "type": "contacts",
      "links": {
        "self": "http://example.org/api/rest/admin/contacts/49"
      },
      "attributes": {
        "email": "rspec_mail_1@example.com",
        "notes": null
      },
      "relationships": {
        "contractor": {
          "links": {
            "self": "http://example.org/api/rest/admin/contacts/49/relationships/contractor",
            "related": "http://example.org/api/rest/admin/contacts/49/contractor"
          },
          "data": {
            "type": "contractors",
            "id": "25"
          }
        }
      }
    },
    {
      "id": "50",
      "type": "contacts",
      "links": {
        "self": "http://example.org/api/rest/admin/contacts/50"
      },
      "attributes": {
        "email": "rspec_mail_2@example.com",
        "notes": null
      },
      "relationships": {
        "contractor": {
          "links": {
            "self": "http://example.org/api/rest/admin/contacts/50/relationships/contractor",
            "related": "http://example.org/api/rest/admin/contacts/50/contractor"
          },
          "data": {
            "type": "contractors",
            "id": "26"
          }
        }
      }
    }
  ],
  "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"
  }
}