TextKitDocs

Retrieve a link domain

GET/v1/link-domains/{id}

Path Parameters

  • idstringrequired

Responses

  • 200LinkDomain

    The link domain

  • 401Error

    Missing, malformed, or revoked API key

  • 402Error

    Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged

  • 404Error

    Not found

  • 429Error

    Rate limit or quota exceeded

Response Fields

  • idstring

    Example: ld_a1B2c3D4e5F6.

  • objectlink_domain
  • domainstring

    Example: links.example.com.

  • statuspending_dns, dns_verified, active

    pending_dns: add the records and verify. dns_verified: the records check out and it is being turned on. active: shorten_links uses it.

  • dns_recordsarray of object

    The records to create at your DNS host.

  • dns_records[].typeCNAME, TXT
  • dns_records[].namestring

    Example: links.example.com.

  • dns_records[].valuestring

    Example: links.jointextkit.com.

  • dns_records[].purposestring
  • created_atstring (date-time)
  • verified_atstring (date-time)

    Nullable.

  • activated_atstring (date-time)

    Nullable.

  • last_checkobject

    Nullable.

  • last_check.atstring (date-time)
  • last_check.cnameboolean
  • last_check.txtboolean

Errors

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

  • 401

    Missing, malformed, or revoked API key

  • 402

    Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged

  • 404

    Not found

  • 429

    Rate limit or quota exceeded