Get Organization by Name

Retrieves a list of organizations whose name contains the specified word or phrase.

Use the Get Organization by ID endpoint to retrieve more detailed information about a specific organization.

This endpoint may return up to 20 organizations. If you reach this limit, try searching for a more specific name.

Request

Retrieve organizations by name through the following request:

HTTP Method	Request URI
GET	https://api.vdms.io/sec/cps/v2.0/organizations/name/Organization Name

Define the following variable when submitting the above request:

VariableA variable represents a value that must be replaced. A variable consists of either a URL segment (e.g., "0001" in /0001/) or a query string value (e.g., "3" in mediaTypes=3).	Description
Organization Name Required	Replace this variable with the name of the desired organization. The response will return all organizations whose names contain the specified word or phrase.

Request Headers

This endpointIdentifies a request's connection point to our REST API service. only takes advantage of common request headers.

Unlike requests to api.edgecast.com, requests to our API gateway (api.vdms.io) require an access token (OAuth).

Request Body

Request body parameters are not required by this endpoint.

Response

The response to the above request includes an HTTP status code, response headers, and a response body.

Status Code

A status code indicates whether the request was successfully performed.

Response Headers

The response for this endpoint only includes standard HTTP response headers.

View common response headers.

Response Body

The response body for a successful request (200 OK) contains the following response elements:

Name	Data Type	Description
@id	String	Indicates the relative path to the requested endpoint.
@type	String	Returns Collection.
items	Array	Contains a list of organizations.

items Array

The items array describes each organization through the following properties:

Name	Data Type	Description
city	String	Indicates an organization's city.
company_address	String	Indicates an organization's address.
company_address2	String	Indicates an organization's secondary address information (e.g., suite number).
company_name	String	Indicates an organization's name.
country	String	Indicates an organization's country by its ISO 3166 country code. Use the Get Country Codes endpoint to retrieve a list of countries and their codes.
id	Integer	Indicates an organization's system-defined ID. Digicert CA If you previously purchased an OV or EV certificate directly from Digicert, then it is possible for your organization to only be registered with Digicert. Organizations that have only been registered with Digicert return an ID of 0. Look up your organization by its exact name, as defined within the company_name property, by requesting the Get Organization by ID endpoint with the following query string syntax: ?name=Organization Name
state	String	Indicates an organization's state or province.
zip_code	String	Indicates an organization's zip code.

Errors

The response body for an unsuccessful request will contain an error response that provides additional information.

Sample Request and Response

A sample JSON request is shown below.

A sample JSON response is shown below.

{
	"@id": "/v2.0/organizations/name/widgets",
	"@type": "Collection",
	"items": [{
			"id": 123,
			"country": "US",
			"state": "California",
			"zip_code": "90094",
			"city": "Los Angeles",
			"company_name": "Widgets, Inc.",
			"company_address": "13031 W Jefferson Blvd",
			"company_address2": "Blvd #900"
		}, {
			"id": 124,
			"country": "US",
			"state": "California",
			"zip_code": "90094",
			"city": "Los Angeles",
			"company_name": "Widgets LLC",
			"company_address": "13031 W Jefferson Blvd",
			"company_address2": "900"
		}
	]
}