List organizations

GET https://www.digicert.com/services/v2/organization

Use this endpoint to list all organizations in your account.

Example requests and responses

Notice

Change the ACCEPT header to text/csv to return a CSV output of the results.

Example 1. cURL

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

Example 2. Python

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)

Example 3. Go

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))

}

Example 4. NodeJS

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);
});

Example 5. 200 OK

{
  "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
  }
}

Example 6. 200 OK (include_validation=true)

{
  "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.

Name	Req/Opt	Type	Description
include_validation	optional	bool	Specify if validation details for the organization should be returned. Default: `false`
filters[`{{property_name}}`]	optional	string	Filters 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[status]`: Use `active` or `inactive`. `filters[validation]`: Use `pending` to include organizations with pending validations, or `not_pending` to include organizations without pending validations. `filters[container_id_for_organization]`: Limits results to organizations for which the given division (`container`) can order certificates. If the given division is the parent division in the account (also referred to as the "root" division), or if the division has no organization restrictions, the API does not apply a division filter on the results.
filters[search]	optional	string	Search for an organization with the given ID (exact match), or limit results to organizations with a `name` that contains the given string.
sort	optional	string	Sorts 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` `name` `is_active` `address` `city` `state` `zip` `country` `telephone` `container_id`
limit	optional	int	Total number of results to include in the response. Max: `1000` (default)
offset	optional	int	Index of the first result to include in the response. Default: `0`

Response parameters

Name	Type	Description
organizations	array	List of organizations returned by the request.
.. id	int	Organization ID.
.. status	string	Organization status. Possible values: `active`, `inactive`. For more information, see Glossary - Organization status.
.. name	string	Legal name of the organization.
.. assumed_name	string	Public name of the organization. Also called DBA name.
.. display_name	string	Full name of the organization. Constructed using name + assumed_name.
.. is_active	bool	Active status of the organization.
.. address	string	Address of the organization.
.. address2	string
.. zip	string	Postal code of the organization.
.. city	string	City where the organization is located.
.. state	string	State where the organization is located.
.. country	string	Country of the organization.
.. container	object	Primary container the organization is attached to.
.. .. id	int	Container ID.
.. .. parent_id	int	ID of the container's parent.
.. .. name	string	Name of the container.
.. .. is_active	bool	Active status of the container.
.. validations	array	Validation types that the organization can use. Only returned if URL query `include_validation=true`.
.. ev_approvers	array	List of users that can approve EV and code signing orders. Only returned if URL query `include_validation=true`.
.. extended validation	object	Extended validation information about the organization. Only returned if URL query `include_validation=true`.
.. container_id_assignments	array	List of containers the organization is assigned to.
page	object	Details about results. Modified using URL query strings.

In this section: