API Home

Requests

Contacts

 /v1/contact POST

Orgs

 /v1/org/{domain} GET
 /v1/org/{domain}/locations GET
 /v1/org/search GET

Locations

 /v1/org/{domain}/locations GET
 /v1/location/{domain} GET

Schemas

ContactAddResponse

object

Response for the Contact Add operation

Properties

Key Required Type Properties
contact

Required

 object
Key Type Description
created boolean Indicates if the Contact was created
id string The id of the Contact
request

Required

 Request

Example 

{
  "contact": {
    "id": "hmxxgqjan478a8vp",
    "created": true
  },
  "request": {
    "id": "caedc1bd-a4d4-4e18-a904-bac04c31fe85",
    "success": true,
    "period_start": "2025-02-03T14:49:40.000Z",
    "next_period_start": "2025-03-03T14:49:40.000Z",
    "requests_this_period": 2000,
    "credit_available_this_period": 10000,
    "credit_used_this_request": 1,
    "credit_used_this_period": 2500,
    "credit_remaining_this_period": 7500,
    "account_id": "fddb84zz.acct.to.co",
    "subscription_id": "Az9g3fSwOBwtj2El"
  }
}