List organizations

  4 minute read  

GET https://www.digicert.com/services/v2/organization
Use this endpoint to list all organizations in your account.

Example requests and responses

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

url = "https://www.digicert.com/services/v2/organization"

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

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

print(response.text)
package main

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

func main() {

	url := "https://www.digicert.com/services/v2/organization"

	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/organization',
  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);
});
{
  "organizations": [
    {
      "id": 1,
      "status": "active",
      "name": "DigiCert Inc.",
      "display_name": "DigiCert Inc.",
      "is_active": true,
      "address": "2801 N Thanksgiving Way",
      "address2": "Suite 500",
      "zip": "84043",
      "city": "Lehi",
      "state": "Utah",
      "country": "us",
      "container": {
        "id": 4,
        "parent_id": 0,
        "name": "DigiCert Inc.",
        "is_active": true
      }
    },
    {
      "id": 112233,
      "status": "active",
      "name": "Example Organization Inc.",
      "assumed_name": "Example Org",
      "display_name": "Example Organization",
      "is_active": true,
      "address": "123 Fake Stree",
      "address2": "Floor 55",
      "zip": "84043",
      "city": "Lehi",
      "state": "Utah",
      "country": "us",
      "telephone": "801-701-9600",
      "container": {
        "id": 4,
        "parent_id": 0,
        "name": "DigiCert Inc.",
        "is_active": true
      },
      "container_id_assignments": [
        "112234",
        "112235"
      ]
    }
  ],
  "page": {
    "total": 2,
    "limit": 1000,
    "offset": 0
  }
}
{
  "organizations": [
    {
      "id": 1,
      "status": "active",
      "name": "DigiCert Inc.",
      "display_name": "DigiCert Inc.",
      "is_active": true,
      "address": "2801 N Thanksgiving Way",
      "address2": "Suite 500",
      "zip": "84043",
      "city": "Lehi",
      "state": "Utah",
      "country": "us",
      "container": {
        "id": 4,
        "parent_id": 0,
        "name": "DigiCert Inc.",
        "is_active": true
      }
    },
    {
      "id": 112233,
      "status": "active",
      "name": "Example Organization Inc.",
      "assumed_name": "Example Org",
      "display_name": "Example Organization",
      "is_active": true,
      "address": "123 Fake Stree",
      "address2": "Floor 55",
      "zip": "84043",
      "city": "Lehi",
      "state": "Utah",
      "country": "us",
      "telephone": "801-701-9600",
      "container": {
        "id": 4,
        "parent_id": 0,
        "name": "DigiCert Inc.",
        "is_active": true
      },
      "container_id_assignments": [
        "112234",
        "112235"
      ]
    }
  ],
  "page": {
    "total": 2,
    "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
include_validationoptionalboolSpecify if validation details for the organization should be returned.
Default:
false
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[search]optionalstringSearch for an organization with the given ID (exact match), or limit results to organizations with a name that contains the given string.
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:
limitoptionalintTotal number of results to include in the response.
Max: 1000 (default)
offsetoptionalintIndex of the first result to include in the response.
Default: 0

Response parameters

NameTypeDescription
organizationsarrayList of organizations returned by the request.
.. idintOrganization ID.
.. statusstringOrganization status.
Possible values: active, inactive. For more information, see Glossary - Organization status.
.. namestringLegal name of the organization.
.. assumed_namestringPublic name of the organization. Also called DBA name.
.. display_namestringFull name of the organization. Constructed using name + assumed_name.
.. is_activeboolActive status of the organization.
.. addressstringAddress of the organization.
.. address2string
.. zipstringPostal code of the organization.
.. citystringCity where the organization is located.
.. statestringState where the organization is located.
.. countrystringCountry of the organization.
.. containerobjectPrimary container the organization is attached to.
.. .. idintContainer ID.
.. .. parent_idintID of the container’s parent.
.. .. namestringName of the container.
.. .. is_activeboolActive status of the container.
.. validationsarrayValidation types that the organization can use. Only returned if URL query include_validation=true.
.. ev_approversarrayList of users that can approve EV and code signing orders. Only returned if URL query include_validation=true.
.. extended validationobjectExtended validation information about the organization. Only returned if URL query include_validation=true.
.. container_id_assignmentsarrayList of containers the organization is assigned to.
pageobjectDetails about results. Modified using URL query strings.