Skip to content

Retrieves the available static source parameters.

Method get.source_parameters
Description Retrieves the available static source parameters.
Who has access Agents and clients

Request parameters

Name Type Required Description
access_token string yes Access token used to authenticate the request.
user_id number no Unique ID of the client user on whose behalf the agent is making the request. Required for agents. To retrieve a list of client users, use "get.customer_users".
limit number no Maximum number of records to return. See the "Paging" section.
offset number no Number of records to skip before returning results. Default: 0. See the "Paging" section.
fields array no Fields to include in the response. See the "Viewing returned data" section.

Response parameters

Name Type Valid values Filtering Sorting Description
id string Unique static parameter ID.
name string Static parameter name.

Example request

{
  "jsonrpc": "2.0",
  "id": "number",
  "method": "get.source_parameters",
  "params": {
    "access_token": "string",
    "user_id": "number",
    "offset": "number",
    "limit": "number"
  }
}

Example response

{
    "jsonrpc": "2.0",
    "id": "number",
    "result": {
        "metadata": {
        },
        "data": [
            {
              "id": "string",
              "name": "string"
            }
        ]
    }
}

Possible errors

See the "Errors for get methods" section.