Jump to

• Request
• Response
• Examples

Get Endpoint URL for a User

get

/rest/api/v1.3/settings/account/endpoint

Retrieves the endpoint URL for the user sending the request. The response returns the API type and the endpoint URL used to send API requests.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Account Endpoints

Type: object

Title: Account Endpoints

Show Source

• apiType: string
  Allowed Values: [ "rest", "soap" ]

  The API type to which the endpoint sends the API requests.
• endPoint: string
  The endpoint URL associated with the Auth Token which is used to send API requests to the API type.

{
    "title":"Account Endpoints",
    "type":"object",
    "properties":{
        "apiType":{
            "description":"The API type to which the endpoint sends the API requests.",
            "type":"string",
            "enum":[
                "rest",
                "soap"
            ]
        },
        "endPoint":{
            "description":"The endpoint URL associated with the Auth Token which is used to send API requests to the API type.",
            "type":"string"
        }
    },
    "required":[
        "apiType",
        "endPoint"
    ]
}

Back to Top

Examples

The following example shows how to retrieve a user's endpoint URL.

FIELDS	DESCRIPTION
Authorization	<AUTH_TOKEN>
Accept	application/json

Sample Request URL:

/rest/api/v1.3/settings/account/endpoint
	

Sample Response: Success

{
  "apiType": "rest",
  "endPoint": "https://XXXXXX-api.responsys.net"
}
	

Back to Top