Skip to main content
GET
/
v1
/
http-request-definition
/
{definitionId}
JavaScript
import Roark from '@roarkanalytics/sdk';

const client = new Roark({
  bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
});

const response = await client.httpRequestDefinition.getByID('definitionId');

console.log(response.data);
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "scope": "AGENT_OUTBOUND_DIAL",
    "description": "<string>",
    "url": "<string>",
    "method": "POST",
    "body": "<string>",
    "parsedBody": {},
    "headers": {},
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

definitionId
string
required

The ID of the HTTP request definition to retrieve

Response

The requested HTTP request definition

data
object
required

HTTP request definition