List invites

GET https://www.digicert.com/services/v2/account/subaccount/invite

Use this endpoint to list all subaccount invites.

Example requests and responses

curl -X GET \
  https://www.digicert.com/services/v2/account/subaccount/invite \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}'
import requests

url = "https://www.digicert.com/services/v2/account/subaccount/invite"

payload = ""
headers = {
    'X-DC-DEVKEY': "{{api_key}}",
    'Content-Type': "application/json"
    }

response = requests.request("GET", url, data=payload, headers=headers)

print(response.text)
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://www.digicert.com/services/v2/account/subaccount/invite"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-DC-DEVKEY", "{{api_key}}")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var request = require("request");

var options = { method: 'GET',
  url: 'https://www.digicert.com/services/v2/account/subaccount/invite',
  headers: 
   { 'Content-Type': 'application/json',
     'X-DC-DEVKEY': '{{api_key}}' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

200 OK

{
  "subaccount_invites": [
    {
      "id": 1,
      "email": "email1@example.com",
      "subaccount_type": "reseller",
      "invite_note": "Sign up for your CertCentral account!",
      "date_created": "2019-01-14 11:17:38",
      "last_sent_date": "2019-01-15 08:22:19",
      "status": "pending"
    },
    {
      "id": 2,
      "email": "email2@example.com",
      "subaccount_type": "enterprise",
      "invite_note": "Sign up for your CertCentral account!",
      "date_created": "2019-01-14 11:18:28",
      "last_sent_date": "2019-01-15 08:22:19",
      "status": "pending"
    },
    {
      "id": 3,
      "email": "email3@example.com",
      "subaccount_type": "retail",
      "invite_note": "Sign up for your CertCentral account!",
      "date_created": "2019-01-14 11:19:54",
      "last_sent_date": "2019-01-15 08:22:19",
      "status": "pending"
    }
  ],
  "page": {
  "total": 3,
  "limit": 1000,
  "offset": 0
  }
}

Filters and URL query parameters

This endpoint supports filters, sorting, and pagination. For general information and examples of the syntax to use when applying filters and sorting results, see Services API – Filters, sorting, and pagination parameters.

NameReq/OptTypeDescription
filters[{{property_name}}]optionalstringFilters results by the specified property.
Replace {{property_name}} in your request with the property to use for filtering. This endpoint supports filtering by the following properties:
  • filters[email]
  • filters[subaccount_type]: See Glossary – Subaccount types.
  • filters[date_created]
  • filters[last_sent_date]
  • filters[status]: Use accepted, expired, or cancelled.
filters[search]optionalstringLimits response to results where the value of the email property matches or contains a specific string of characters.
To search for values that contain a specific string of characters, prefix the string with a URL encoded (percent-encoded) % character: %25. To search for values that are an exact match for a string of characters, omit the %25 from the request.
Examples:
  • filters[search]=%25gmail Limits response to results where the value of a searched property contains the string gmail
  • filters[search]=myname@gmail.com Limits response to results where the value of a searched property is an exact match for the string myname@gmail.com.
sortoptionalstringSorts results by the value of one or more properties.
By default, sorts results in ascending alphabetical order (0-9, A-Z). To sort in descending alphabetical order (9-0, Z-A), prefix the property name with a minus (-).
To sort by multiple properties, separate the name of each property with a comma. Sort hierarchy matches the order of properties in this list.
This endpoint supports sorting by the following properties:
  • id
  • email
  • subaccount_type
  • invite_note
  • date_created
  • last_sent_date
  • status
  • firstname
  • lastname
offsetoptionalintIndex of the first result to include in the response.
Default: 0
limitoptionalintTotal number of results to include in the response.
Max: 1000 (default)

Response parameters

NameTypeDescription
subaccount_invitesarrayList of subaccount invites.
.. idintInvitation ID.
.. emailstringEmail address where the invitation was sent.
.. subaccount_typestringDefines the subaccount type. See Glossary – Subaccount types
.. invite_notestringCustom invitation message sent with the invite.
.. date_createdstringDate the invite was first sent.
Format: yyyy-MM-dd HH:mm:ss
.. last_sent_datestringDate the invite was last resent.
Format: yyyy-MM-dd HH:mm:ss
.. statusstringStatus of the invitation.
Possible values: accepted, pending, canceled, expired
pageobjectDetails about results. Modified using URL query strings.