Contractors API

get listing

GET /api/rest/admin/contractors

Parameters

Name	Description
filter[id]	id filter
filter[name]	name filter
filter[smtp-connection.id]	smtp connection.id filter
filter[name-eq]	name eq filter
filter[name-not-eq]	name not eq filter
filter[name-cont]	name cont filter
filter[name-start]	name start filter
filter[name-end]	name end filter
filter[name-in]	name in filter
filter[name-not-in]	name not in filter
filter[name-cont-any]	name cont any filter
filter[enabled-eq]	enabled eq filter
filter[enabled-not-eq]	enabled not eq filter
filter[vendor-eq]	vendor eq filter
filter[vendor-not-eq]	vendor not eq filter
filter[customer-eq]	customer eq filter
filter[customer-not-eq]	customer not eq filter
filter[description-eq]	description eq filter
filter[description-not-eq]	description not eq filter
filter[description-cont]	description cont filter
filter[description-start]	description start filter
filter[description-end]	description end filter
filter[description-in]	description in filter
filter[description-not-in]	description not in filter
filter[description-cont-any]	description cont any filter
filter[address-eq]	address eq filter
filter[address-not-eq]	address not eq filter
filter[address-cont]	address cont filter
filter[address-start]	address start filter
filter[address-end]	address end filter
filter[address-in]	address in filter
filter[address-not-in]	address not in filter
filter[address-cont-any]	address cont any filter
filter[phones-eq]	phones eq filter
filter[phones-not-eq]	phones not eq filter
filter[phones-cont]	phones cont filter
filter[phones-start]	phones start filter
filter[phones-end]	phones end filter
filter[phones-in]	phones in filter
filter[phones-not-in]	phones not in filter
filter[phones-cont-any]	phones cont any filter
filter[external-id-eq]	external id eq filter
filter[external-id-not-eq]	external id not eq filter
filter[external-id-gt]	external id gt filter
filter[external-id-gteq]	external id gteq filter
filter[external-id-lt]	external id lt filter
filter[external-id-lteq]	external id lteq filter
filter[external-id-in]	external id in filter
filter[external-id-not-in]	external id not in filter

Request

Headers

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjY0LCJhdWQiOlsiYWRtaW4iXSwiZXhwIjoxNzcyMjEyMDAxfQ.tXkpQHewclEG4fVT_dPhZUnZM429uNWJAO37J8_dCyI
Host: example.org
Cookie: 

Route

GET /api/rest/admin/contractors

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/"310cbde8e2c06a1f8cb7a577a909c72a"
cache-control: max-age=0, private, must-revalidate
x-request-id: fbad9ffb-1025-427f-9ae7-e0589b53036c
x-runtime: 0.007366
content-length: 1178

Status

200 OK

Body

{
  "data": [
    {
      "id": "30",
      "type": "contractors",
      "links": {
        "self": "http://example.org/api/rest/admin/contractors/30"
      },
      "attributes": {
        "name": "contractor30",
        "enabled": true,
        "vendor": true,
        "customer": false,
        "description": null,
        "address": null,
        "phones": null,
        "external-id": 30
      },
      "relationships": {
        "smtp-connection": {
          "links": {
            "self": "http://example.org/api/rest/admin/contractors/30/relationships/smtp-connection",
            "related": "http://example.org/api/rest/admin/contractors/30/smtp-connection"
          },
          "data": null
        }
      }
    },
    {
      "id": "31",
      "type": "contractors",
      "links": {
        "self": "http://example.org/api/rest/admin/contractors/31"
      },
      "attributes": {
        "name": "contractor31",
        "enabled": true,
        "vendor": true,
        "customer": false,
        "description": null,
        "address": null,
        "phones": null,
        "external-id": 31
      },
      "relationships": {
        "smtp-connection": {
          "links": {
            "self": "http://example.org/api/rest/admin/contractors/31/relationships/smtp-connection",
            "related": "http://example.org/api/rest/admin/contractors/31/smtp-connection"
          },
          "data": null
        }
      }
    }
  ],
  "meta": {
    "total-count": 2
  },
  "links": {
    "first": "http://example.org/api/rest/admin/contractors?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "http://example.org/api/rest/admin/contractors?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}