• Register



Fetch a single service object.  Please see Fetching Objects for an overview of how the fetch method works.


service key

A string representing the unique id of the service to fetch.  You may also pass a json object with a field of service_key to identify the service you wish to fetch.


An service object, as described by the object.describe call. NULL is returned if the member could not be found.


A Sample JSON-RPC Service Fetch Request

       "method": "service.fetch",
       "params": [1001],
       "id": 1

The JSON-RPC Response

    "result": { /* Service Object Here */ },
    "error": null,
    "id": 1

Permissions Required

The user who owns the key used to authenticate the service.fetch call must be a member of one of the following roles

  • Administrator
  • Api Manager

See authentication.


In addition to the standard json-rpc errors and authentication errors, service.fetch may also return these errors:

HTTP Status Code JSON-RPC Code Error Message Description
400 1002 Field "service_key" is required You've passed an object to trigger the alternative object identifier syntax, but that object does not contain a service_key field.

Docs Navigation