LookupId-List API Endpoint
Overview
The LookupId-List
endpoint provides a comprehensive list of all available and current customer subscription endpoints, including their exact names and associated lookup ID numbers. These lookup IDs are crucial as they are required to trigger each specific endpoint within the API. This endpoint is essential for developers to understand and utilize the correct lookup IDs to access the various services provided by the API.
Endpoint
URL
Method
GET
Headers
accept: application/json
Content-Type: application/json
Example Request
Here’s an example of how to request the list of lookup IDs using curl
. Note that the API key is sanitized for security:
Replace YOUR_API_KEY
with your actual API key.
Response
Response Body
The response is a JSON array where each object contains:
lookupId: The unique identifier required to trigger a specific endpoint.
endPoint: The exact API endpoint that can be triggered using the
lookupId
.lookupName: A descriptive name of the endpoint for easier identification.
Example Response
Usage Notes
Lookup ID: To trigger any specific endpoint, the corresponding
lookupId
must be included in your request.Endpoint Names: The
lookupName
provides a human-readable identifier for each endpoint, making it easier to identify the services available to your account.
This endpoint is particularly useful for developers needing to dynamically interact with various services offered by the API without hardcoding endpoint details.
Last updated