​

ves-io-schema-signup-CustomAPI-Get

Published April 5, 2023 | Last modified September 10, 2026

Examples of performing signup CustomAPI Get

Usecase:

Get signup

Request:

Request using vesctl:

vesctl request rpc signup.CustomAPI.Get -i request.yaml --uri /no_auth/signup/signup-1234-5678-9012-3456 --http-method GET

where file request.yaml has following contents:

name: signup-1234-5678-9012-3456

vesctl yaml response:

object:
  metadata:
    annotations: {}
    labels: {}
    name: signup-1234-5678-9012-3456
    namespace: system
    uid: a1ebc184-aa9a-473c-9dac-a7fe5321b838
  spec:
    gcSpec:
      billingAddress: {}
      company:
        contacts: []
        groups: []
      companyContact: {}
      companyName: test
      contactNumber: "123456789"
      currency: USD
      customer:
        contacts: []
        groups: []
      customerContact: {}
      domain: testdomain
      email: test@test.com
      firstName: Test
      infraprotectInfo:
        prefixes:
        - 0.0.0.0/0
        uuid: a4189a5a-a068-431f-a3d4-965e622016a8
      lastName: Test
      locale: en_US
      paymentProviderToken: tok_1234567899
      supportPlanName: support-plan-1
      token: ed865e78-fafc-4b64-a65d-cf7fa2e9d776
      tosAccepted: "1234567"
      tosVersion: v1.2
      usagePlanName: usage-plan-1
  systemMetadata:
    finalizers: []
    labels: {}
    namespace: []
    tenant: ves-io
    uid: a1ebc184-aa9a-473c-9dac-a7fe5321b838
status: []

Request using curl:

curl -X 'GET' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_q2_3kp8z3zs0x5_m7pk1bgb0_ph0000gp_T_go-build1655461974_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://localhost:62500/no_auth/signup/signup-1234-5678-9012-3456?name=signup-1234-5678-9012-3456'

curl response:

HTTP/1.1 200 OK
Content-Type: application/json
Date: Fri, 19 Jun 2026 22:06:19 GMT
Vary: Accept-Encoding


{
  "object": {
    "metadata": {
      "name": "signup-1234-5678-9012-3456",
      "namespace": "system",
      "uid": "a1ebc184-aa9a-473c-9dac-a7fe5321b838",
      "labels": {
      },
      "annotations": {
      },
      "description": "",
      "disable": false
    },
    "system_metadata": {
      "uid": "a1ebc184-aa9a-473c-9dac-a7fe5321b838",
      "creation_timestamp": null,
      "deletion_timestamp": null,
      "modification_timestamp": null,
      "initializers": null,
      "finalizers": [
      ],
      "tenant": "ves-io",
      "creator_class": "",
      "creator_id": "",
      "creator_cookie": "",
      "trace_info": "",
      "object_index": 0,
      "namespace": [
      ],
      "owner_view": null,
      "sre_disable": false,
      "vtrp_id": "",
      "vtrp_stale": false,
      "labels": {
      },
      "direct_ref_hash": "",
      "revision": "0"
    },
    "spec": {
      "gc_spec": {
        "locale": "en_US",
        "type": "UNKNOWN",
        "first_name": "Test",
        "last_name": "Test",
        "email": "test@test.com",
        "contact_number": "123456789",
        "domain": "testdomain",
        "currency": "USD",
        "payment_provider_token": "tok_1234567899",
        "billing_address": {
          "contact_type": "MAILING",
          "phone_number": "",
          "address1": "",
          "address2": "",
          "city": "",
          "county": "",
          "state": "",
          "state_code": "",
          "country": "",
          "zip_code": ""
        },
        "tos_accepted": "1234567",
        "customer": {
          "type": "USER",
          "locale": "",
          "first_name": "",
          "last_name": "",
          "email": "",
          "contacts": [
          ],
          "tos_accepted": "",
          "domain_owner": false,
          "idm_type": "SSO",
          "state": "StateUndefined",
          "last_login_timestamp": null,
          "groups": [
          ],
          "tos_version": "",
          "tos_accepted_at": null,
          "sync_mode": "SELF"
        },
        "customer_contact": {
          "contact_type": "MAILING",
          "phone_number": "",
          "address1": "",
          "address2": "",
          "city": "",
          "county": "",
          "state": "",
          "state_code": "",
          "country": "",
          "zip_code": ""
        },
        "company_name": "test",
        "company": {
          "type": "USER",
          "locale": "",
          "first_name": "",
          "last_name": "",
          "email": "",
          "contacts": [
          ],
          "tos_accepted": "",
          "domain_owner": false,
          "idm_type": "SSO",
          "state": "StateUndefined",
          "last_login_timestamp": null,
          "groups": [
          ],
          "tos_version": "",
          "tos_accepted_at": null,
          "sync_mode": "SELF"
        },
        "company_contact": {
          "contact_type": "MAILING",
          "phone_number": "",
          "address1": "",
          "address2": "",
          "city": "",
          "county": "",
          "state": "",
          "state_code": "",
          "country": "",
          "zip_code": ""
        },
        "token": "ed865e78-fafc-4b64-a65d-cf7fa2e9d776",
        "support_plan_name": "support-plan-1",
        "usage_plan_name": "usage-plan-1",
        "tos_version": "v1.2",
        "tax_exempt": "TAX_UNKNOWN",
        "infraprotect_info": {
          "asn": 0,
          "uuid": "a4189a5a-a068-431f-a3d4-965e622016a8",
          "prefixes": [
            "0.0.0.0/0"
          ],
          "arbor_cid": "",
          "primary_network_name": "",
          "policer": null
        },
        "billing_provider_account_id": "",
        "tos_accepted_at": null,
        "sfdc_subscription_id": "",
        "crm_details": null
      }
    }
  },
  "status": [
  ]
}
On this page: