GET
/
schedulers
/
{id}
curl --request GET \
  --url https://api.syntage.com/schedulers/{id} \
  --header 'X-API-Key: <api-key>'
{
  "@context": "/contexts/Scheduler",
  "@id": "/schedulers/91106968-1abd-4d64-85c1-4e73d96fb997",
  "@type": "Scheduler",
  "id": "e0a24894-7fbf-48ae-bfb0-efaae30a6319",
  "name": "Daily Invoices Scheduler",
  "type": "recurring",
  "isEnabled": true,
  "rules": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "hydra:Collection",
    "hydra:member": [
      {
        "@id": "/schedulers/rules/91106968-1abd-4d64-85c1-4e73d96fb997",
        "@type": "SchedulerRule",
        "id": "e0a24894-7fbf-48ae-bfb0-efaae30a6319",
        "scheduler": "Daily Invoices Scheduler",
        "extractor": "invoice",
        "options": {
          "types": [
            "I",
            "E",
            "P"
          ],
          "period": {
            "from": "2020-01-01T00:00:00.000Z",
            "to": "2020-03-31T23:59:59.000Z"
          }
        },
        "cronExpression": "@daily",
        "nextRunDate": "2020-01-01T12:15:00.000Z",
        "createdAt": "2020-01-01T12:15:00.000Z",
        "updatedAt": "2020-01-01T12:15:00.000Z"
      }
    ],
    "hydra:totalItems": 1,
    "hydra:view": {
      "@id": "/schedulers/rules?page=1",
      "@type": "<string>",
      "hydra:first": "/schedulers/rules?page=1",
      "hydra:next": "/schedulers/rules?page=2",
      "hydra:last": "/schedulers/rules?page=3"
    },
    "hydra:search": {
      "@type": "<string>",
      "hydra:template": "<string>",
      "hydra:variableRepresentation": "<string>",
      "hydra:mapping": [
        {
          "@type": "<string>",
          "variable": "<string>",
          "property": "<string>",
          "required": true
        }
      ]
    }
  },
  "tags": [
    {
      "@id": "/entity-tags/91106968-1abd-4d64-85c1-4e73d96fb997",
      "@type": "EntityTag",
      "id": "e0a24894-7fbf-48ae-bfb0-efaae30a6319",
      "name": "Important Taxpayer",
      "createdAt": "2020-01-01T12:15:00.000Z",
      "updatedAt": "2020-01-01T12:15:00.000Z"
    }
  ],
  "createdAt": "2020-01-01T12:15:00.000Z",
  "updatedAt": "2020-01-01T12:15:00.000Z"
}

Authorizations

X-API-Key
string
header
required

Your API key is available in the Production and Sandbox dashboards.

Path Parameters

id
string
required

Response

200
application/ld+json

Scheduler resource response

The response is of type object.